डॉक्सिजन

Question

के साथ मुख्य पृष्ठ पर फ़ंक्शन सूची मुझे यकीन है कि यह पहले ही कहीं से पूछा जा चुका है लेकिन मुझे यह नहीं लगता है, इसलिए यह यहां जाता है।

मैं सी में एक प्रोग्राम बना रहा हूं और दस्तावेज उत्पन्न करने के लिए डॉक्सीजन का उपयोग कर रहा हूं। मैं परिणामों से काफी संतुष्ट हूं, हालांकि मुख्य पृष्ठ में कोई सामग्री नहीं है। मैं मुख्य पृष्ठ को वर्णमाला क्रम में प्रोग्राम में उपयोग किए गए सभी कार्यों और संरचनाओं की एक सूची के साथ भरना चाहता हूं।

मुझे सरल ट्यूटोरियल से परे डॉक्सिजन के बारे में बहुत कुछ पता नहीं है, जिसे मैंने अभी तक प्राप्त करने के लिए उपयोग किया है। ऐसा लगता है कि डॉक्सिजन ऐसा करने में सक्षम होगा, लेकिन अब तक जो कुछ मैंने पाया है वह एक कस्टम मुख्य पृष्ठ बनाने के निर्देश हैं।

क्या मुख्य पृष्ठ पर फ़ंक्शंस और संरचनाओं की सूची स्वचालित रूप से उत्पन्न करने के लिए डॉक्सीजन का उपयोग करना संभव है?

Answer 1

मैं आपको @mainpage का उपयोग करने की सलाह देता हूं। इस फ़ंक्शन ने मुख्य पृष्ठ के शीर्षलेख को बदल दिया और उसके बाद आप छोटी जानकारी के लिए @brief जैसे फ़ंक्शंस का उपयोग कर सकते हैं।

अनुभाग बनाने के लिए HTML टैग का उपयोग करें, मेरे लिए यह काम करता है। फिर फ़ंक्शन @see के साथ नए अनुभाग में आप मुख्य पृष्ठ से फ़ंक्शंस या फ़ाइलों पर जा सकते हैं। यह एक कामकाजी नमूना है:

/** 
*  @mainpage WATCHDOG 
*  <hr/> 
*  @setion <b> File tree<b/> 
*  @brief Here you can see the main files which are used. 
*  @see io.c 
*  @see watchdog.c 
*  @see watchdog.h 
*  <p/><br/> 
*  <hr/> 
*  In this part we have few main functions used by the programm 
*  <p/><br/> 
*  @see watchdog_init_s(); 
*  @see fpga_resetregs_init_s(); 
*  @see watchdog_read(int add, unsigned int ws); 
*  @see watchdog_reset_io_write(WD * watchdog, unsigned int* data,unsigned int *ws); 
*  <hr/> 
*/