Doxygen के साथ उदाहरणों को एकीकृत कैसे करें?

Question

मैंने अपने सभी वर्गों को दस्तावेज किया और अब मैं इन वर्गों का उपयोग करने के उदाहरण को एकीकृत करना चाहता हूं। मैं उसको कैसे करू?

Answer 1

आप EXAMPLE_PATH के तहत डॉक्सिजन कॉन्फ़िगरेशन में परिभाषित एक विशेष पथ में उदाहरण स्रोत कोड डाल सकते हैं, और फिर @example टैग के साथ उदाहरण डालें।

डॉक्सिजन फिर एक अतिरिक्त पृष्ठ उत्पन्न करेगा जिसमें उदाहरण का स्रोत होगा। यह उदाहरण टैग वाले वर्ग दस्तावेज से भी एक लिंक सेट करेगा।

वैकल्पिक रूप से आप उन्हें @code ... @endcode

इस के लिए प्रलेखन के साथ सम्मिलित कर सकते हैं आप छोटे कोड स्निपेट का उपयोग करना चाहते हैं तो यहाँ है: Doxygen documentation?

Answer 2

मुझे दस्तावेज़ में उदाहरण फ़ाइल शामिल करने के लिए @example का उपयोग करके कुछ त्रुटियां थीं। यह वह कामकाज है जिसका मैंने उपयोग किया था।

विशेष रूप से उदाहरण कोड के लिए फ़ोल्डर/प्रोजेक्ट में examplefile.cs रखें। प्लेस कि Doxygen EXCLUDE सूची में फ़ोल्डर (विशेषज्ञ> इनपुट-> EXCLUDEin Doxygen जीयूआई दृश्यपटल) और EXAMPLE_PATH (Doxygen जीयूआई दृश्यपटल में विशेषज्ञ> इनपुट-> EXAMPLE_PATH)

प्लेस में इस कोड को ब्लॉक कहीं में एक दस्तावेज फ़ाइल (मैं इसे फ़ाइल उदाहरण के लिए है में डाल दिया।)

/** @example examplefile.cs 
* A description of the example file, causes the example file to show up in 
* Examples */ 

यह Doxygen मेनू में उदाहरण के अंतर्गत दिखाई दें फ़ाइल का कारण बनता है, लेकिन अपनी परियोजना में एक वर्ग/फ़ाइल के रूप में दिखाई नहीं।

फिर अपने वर्ग/समारोह दस्तावेज़:

/** @brief MyClass does something 
* @details I have something more long winded to say about it. See example 
* in examplefile.cs: @include examplefile.cs */ 

यह बाहर मुद्रित करने के लिए यह MyClass के दस्तावेज में संपूर्णता में उदाहरण फ़ाइल का कारण बनता है।

Answer 3

1. INPUT = example_list.h \

(भाषा doxyfile में doxyfile को EXAMPLE_PATH = dir_example \

एक ही फाइल में इस तरह के example_list.h में उदाहरण के सभी कनेक्ट कर सकते हैं एक तरह से जोड़ने और इसे शामिल - रूसी) http://www.scale-tech.ru/SimBookmaker/doc/html/examples__list_8h_source.html और http://www.scale-tech.ru/SimBookmaker/doc/html/examples.html

Answer 4

ऐसा करने का एक और तरीका \snippet कमांड का उपयोग करना है।

• की तरह अपने हेडर फाइल कुछ लिखने में:

\section ex1 Example 
\snippet path_to_test_class/TestClass.cpp TestClass example 
\section ex2 Expected output 
\snippet path_to_test_class/TestClass.cpp TestClass expected output 

• TestClass में।

//! [OptimizeSpeedOnTrackTest example] 
Class c; 
const double res = c.do_something(); 
//! [OptimizeSpeedOnTrackTest example] 
//! [OptimizeSpeedOnTrackTest expected output] 
ASSERT_DOUBLE_EQ(5,res); 
//! [OptimizeSpeedOnTrackTest expected output] 

path_to_test_class अपने EXAMPLE_PATH में होना चाहिए: cpp फ़ाइल, जैसे कुछ है।

• आपका उदाहरण प्रलेखन के लिए सिर्फ वहाँ नहीं कर रहे हैं: परीक्षण कवरेज वे प्रदान के साथ-साथ
• आपका परीक्षण धावक (& अपने संकलक) आप बीमा है कि आपके उदाहरण देने

  यह आप निम्नलिखित देता है वास्तव में & रन संकलन

• यह एक TDD कार्यप्रवाह में बहुत अच्छी तरह से फिट बैठता है में