2012-11-30 10 views
17

मुझे डॉक्सिजन 1.8.2 के साथ एक अजीब समस्या दिखाई देती है। हेडर लेबल सहित हेडर शीर्षक आउटपुट एचटीएमएल से गायब हो जाता है।डॉक्सिजन मार्कडाउन पेज में हेडर लेबल हेडर शीर्षक गायब हो जाता है

निम्नलिखित markdown फ़ाइल के साथ

:,

शीर्षक

खंड 1

के लिए पाठ लेकिन अगर मैं:

Title   {#title} 
===== 

Section 1  {#section1} 
--------- 
Text for section 1 

मैं के रूप में आउटपुट प्राप्तहटाएं markdown फ़ाइल से 23,210 लेबल, मैं के रूप में सही उत्पादन प्राप्त करें:

शीर्षक

धारा 1

खंड 1

के लिए पाठ क्या गलती है मैं मैं यहाँ बना रहा हूँ?

संपादित मैं निम्न चेतावनी मनाया जब मैं एक खंड लेबल:

warning: found subsection command outside of section context! 
+0

मैं इस व्यवहार को एक साधारण परीक्षण मामले में पुन: पेश करने में असमर्थ था, जो कि डिज़ाइन 1.8.2 के लिए डिफ़ॉल्ट जेनरेट की गई कॉन्फ़िगरेशन फ़ाइल के साथ था। क्या आप इस व्यवहार को अकेले स्टैंड टेस्ट केस में या बड़े दस्तावेज़ सेट के हिस्से के रूप में देखते हैं? कॉन्फ़िगरेशन फ़ाइल सहित, जिन फ़ाइलों के साथ आप काम कर रहे हैं, उनकी सटीक सामग्री पोस्ट करने की आवश्यकता हो सकती है। – DRH

+0

1.8.8 के साथ समान "समस्या"। मेरे पास एक README.md था जो सटीक वही काम करता था, लेकिन शीर्ष शीर्षलेख के लिए लेबल के बिना। –

उत्तर

19

कुछ जांच के बाद, मैं इस प्रकट होता है एक बग हो सकता है, लेकिन केवल क्योंकि यह थोड़ा जवाबी सहज है का फैसला किया है ।

निम्नलिखित पर विचार करें:

The Main Section {#the_main_section} 
================ 

Subsection One {#first} 
-------------- 

Something highly interesting... 

दस्तावेज़ एक स्तर 1 हैडर (वर्णित here के रूप में) के साथ शुरू होता है और इसलिए Doxygen नाम और पृष्ठ के शीर्षक के रूप में पार्स करता है "मुख्य धारा"। हेडर को पेज नाम में परिवर्तित करने के बाद हेडर और लेबल {#the_main_section} को उपेक्षा किया जा सकता है।

प्रसंस्करण तब बाकी दस्तावेज़ पर चलता है और जब यह "सबसेक्शन वन" तक पहुंच जाता है, तो यह मानता है कि "उपधारा" के लिए कोई अभिभावक "खंड" नहीं है (जैसा कि "अनुभाग" को किसी पृष्ठ में परिवर्तित किया गया था नाम) और यह वह जगह है जहां यह चोक करता है।

अधिक विशेष रूप से, यह उपधारा (हेडर) को त्याग देता है क्योंकि ऐसा लगता है कि कोई अभिभावक "खंड" नहीं है। अन्य सभी पाठ बनी हुई है, लेकिन इसे "पृष्ठ" (किसी भी अनुभाग अभिभावक के साथ) के हिस्से के रूप में माना जाता है।

प्रारंभिक "स्तर 1 शीर्षलेख" के बाद "फिक्स" एक और "स्तर 1 शीर्षलेख" जोड़ना है।

My Great Documentation (Which Becomes the Page Name) 
==================================================== 

The First Section 
================= 

Q. What? I already created a level 1 heading? 
A. Yup, but that was converted to a page name/title and discarded, so now 
    we have to create another level 1 heading for my first section. Don't 
    be fooled into thinking that the opening heading in this document is 
    still treated as an opening heading by Doxygen - it's not! 
+2

मुझे यह जोड़ना चाहिए कि यह अभी भी समझा नहीं गया है (न ही यह मुझे स्पष्ट है) लेबल को हटाने का कारण मार्कडाउन की सही ढंग से काम करने की उपस्थिति देता है। मैं कहता हूं "उपस्थिति देता है", क्योंकि यदि आप लेबल हटाते हैं और दस्तावेज़ में '[TOC]' जोड़ने का प्रयास करते हैं, तो कोई टीओसी नहीं बनाया जाता है! यदि आप ऊपर वर्णित "वर्कअराउंड" को लागू करते हैं, तो पार्स किए गए दस्तावेज़ में सही दिखाई देता है ** और ** अनुभाग/उपखंड शीर्षकों के लिंक के साथ टीओसी शामिल है। –

+0

यहां एक ऐसा पृष्ठ है जो इन मुद्दों पर चर्चा करता है (आपकी टिप्पणी से एक सहित): http://svenax.net/site/2013/07/creating-user-documentation-with-doxygen/। एकमात्र चीज जिसका उल्लेख नहीं किया गया है वह है कि शीर्षतम शीर्षलेख (पृष्ठ नाम को छोड़कर) सहित सभी वर्गों को लेबल नहीं करना, उनमें से कोई भी बिल्कुल टीओसी में नहीं, बल्कि पृष्ठ पर ही दिखने का कारण बनता है। –

+1

** Googlers को नोट करें: ** यह 2015 है और डॉक्सिजन 1.8.9.1 अभी भी यह बग है! समाधान के लिए धन्यवाद लेस्टर :) – MickyD

1

संस्करण 1.8.9.1 में एक ही समस्या। आप इसके बजाए # टैग का उपयोग करके इससे बच सकते हैं ---।

उदाहरण के लिए:

[TOC] 

Page Title {#pageTitle} 
========== 
Lorem ipsum dolor sit amet 

# section 1 {#section1} 
Lorem ipsum dolor sit amet 

## Section 1.1 {#section1-1} 
Lorem ipsum dolor sit amet 

# section 2 {#section2} 
Lorem ipsum dolor sit amet 

# section 3 {#section3} 
Lorem ipsum dolor sit amet 

## section 3.1 {#section3-1} 
Lorem ipsum dolor sit amet 

# section 4 {#section4} 
Lorem ipsum dolor sit amet 

काम करेंगे।आप सामग्री के सारणी से इसे हटाने के लिए पृष्ठ शीर्षक परिभाषा के नीचे [TOC] टैग भी डाल सकते हैं।

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