2011-03-08 15 views
8

में किसी सेक्शन में जोड़ देगा, मैं \fn\param या \var के समान डॉक्सिजन में कस्टम कमांड बनाना चाहता हूं।नया कस्टम कमांड बनाएं जो डॉक्सिजन

/** 
    \option option_1 This is the first option. 
    \option option_2 This is the second option. 
*/ 

की तरह एक निर्गम के साथ:

        विकल्प:

उदाहरण के लिए मैं इस प्रकार एक \option आदेश जो मैं प्रयोग करेंगे बनाने में सक्षम होना चाहते हैं                 विकल्प_1 यह पहला विकल्प है।
                यह option_2 दूसरा विकल्प है।




एक सरल प्रतिस्थापन उर्फ ​​काम नहीं करता। इस उर्फ ​​साथ उदाहरण के लिए:

        विकल्प::
              यह option_1   पहला विकल्प है

ALIASES = option="\par Options:\n" 

मैं निम्नलिखित उत्पादन मिलता है।

        विकल्प:
                यह option_2 दूसरा विकल्प है।

जो मैं नहीं ढूंढ रहा हूं।


इनाम:

किसी भी आगे स्पष्टीकरण की जरूरत है, तो मेरे सवाल देखें: Doxygen - Create custom command

उत्तर

3

हालांकि यह @param के रूप में साफ नहीं है, आप निम्न उपनामों के साथ समान व्यवहार का अनुकरण कर सकते हैं:

ALIASES += options="<dl class="params"><dt>Options</dt><dd><table class="params">" 
ALIASES += option{2}="<tr><td class="paramname">\1</td><td>\2</td></tr>" 
ALIASES += endoptions="</table></dd></dl>" 

उपनाम के रूप में उत्पादन आप देख रहे हैं निर्माण करने के लिए इस प्रकार किया जा सकता है:

/** 
* @options 
* @option{ option_1, This is the first option. } 
* @option{ option_2, This is the second option. } 
* @endoptions 
*/ 

नोट: यह एचटीएमएल केंद्रित है और संभावना अन्य प्रारूपों के लिए उचित उत्पादन का उत्पादन नहीं होगा।

0

यह xrefitem तरह लग रहा है के रूप में इस पिछले प्रश्न में उत्तर दिया कि तुम क्या चाहते हो सकता है: Custom tags with Doxygen

+1

दिया गया आदेश के लिए एक अलग पृष्ठ बनाने और उस पृष्ठ के लिंक बनाने के लिए यह आदेश क्या है। विधि प्रलेखन के लिए आउटपुट मेरे सरल उपनाम के समान है। निश्चित रूप से मैं जो खोज रहा हूं वह नहीं। – amicitas

संबंधित मुद्दे