Qt 5.11 - Document Structure

दस्तावेज़ संरचना




qt

दस्तावेज़ संरचना

दस्तावेज़ संरचना कमांड आपके दस्तावेज़ को अनुभागों में विभाजित करने के लिए हैं। QDoc अनुभाग के चार स्तरों का समर्थन करता है: \section1 , \section2 , \section3 \section2 \section3 , और \section4 \section2 । अनुभाग आदेश पारंपरिक अनुभाग, उपधारा, आदि की रूपरेखा बनाने में उपयोग किया जाता है।

अनुभाग आदेश

सामान्य तौर पर एक डॉक्यूमेंट स्ट्रक्चुरिंग कमांड सब कुछ मानती है जो इसका अनुसरण करता है जब तक कि पहली लाइन उसके तर्क के रूप में नहीं टूटती। तर्क को इकाई के शीर्षक के रूप में प्रस्तुत किया गया है। यदि शीर्षक को कई लाइनों पर फैलाया जाना है, तो सुनिश्चित करें कि प्रत्येक पंक्ति (पिछले एक को छोड़कर) को बैकस्लैश के साथ समाप्त किया गया है।

कुल मिलाकर, QDoc में वर्गों के लिए चार स्तर हैं: \section1 , \section2 , \section3 \section2 \section3 और \section4 \section2 । ये पारंपरिक अनुभाग, उपधारा, सदस्यता और सदस्यता के अनुरूप हैं।

अनुभाग इकाइयों का सख्त आदेश है:

section1
       |
       section2
              |
              section3
                     |
                     section4

जब अनुभागों का उपयोग किया जाता है, तो पहला अनुभाग कमांड सेक्शन 1 होना चाहिए।

/ *!
    \section1 Basic Qt

    This is the first section.


        \section2 Getting Started

        This is the first subsection.


            \section3 Hello Qt

            This is the first subsubsection.


            \section3 Making Connections

            This is the second subsubsection.


            \section3 Using the Reference Documentation

            This is the third subsubsection.


        \section2 Creating Dialogs

        This is the second subsection.


            \section3 Subclassing QDialog

            This is the first subsubsection.

            ...


    \section1 Intermediate Qt

    This is the second section.


        \section2 Layout Management

        This is the second section's first subsection.


            \section3 Basic Layouts

            This is the first subsubsection.

    ...
* /

QDoc इसे प्रस्तुत करता है:

बेसिक क्यूटी

यह पहला खंड है।

शुरू करना

यह पहली उपधारा है।

हैलो क्यूटी

यह पहली सदस्यता है।

संबंध बनानाा

यह दूसरी सदस्यता है।

संदर्भ प्रलेखन का उपयोग करना

यह तीसरी उपसमुच्चय है।

संवाद बनाना

यह दूसरी उपधारा है।

उपक्लासिंग QDialog

यह पहली सदस्यता है।

...

मध्यवर्ती Qt

यह दूसरा खंड है।

लेआउट प्रबंधन

यह दूसरे खंड की पहली उपधारा है।

बुनियादी लेआउट

यह पहली सदस्यता है।

...

दस्तावेज़ में प्रत्येक अनुभाग एक तार्किक इकाई है। अनुभाग शीर्षक सामग्री के स्वचालित रूप से उत्पन्न तालिका में दिखाई देता है जो सामान्य रूप से पृष्ठ के ऊपरी दाएं कोने में दिखाई देता है।

\अनुभाग एक

\ Section1 कमांड एक नया सेक्शन शुरू करता है।

विभिन्न अनुभाग इकाइयों, कमांड तर्क, और प्रतिपादन के स्पष्टीकरण के लिए अनुभाग कमांड देखें।

\धारा 2

\ Section2 कमांड एक नया सेक्शन शुरू करता है।

विभिन्न अनुभाग इकाइयों, कमांड तर्क, और प्रतिपादन के स्पष्टीकरण के लिए अनुभाग कमांड देखें।

\धारा 3

\ Section3 कमांड एक नया सेक्शन शुरू करता है।

विभिन्न अनुभाग इकाइयों, कमांड तर्क, और प्रतिपादन के स्पष्टीकरण के लिए अनुभाग कमांड देखें।

\ section4

\ Section4 कमांड एक नया सेक्शन शुरू करता है।

विभिन्न अनुभाग इकाइयों, कमांड तर्क, और प्रतिपादन के स्पष्टीकरण के लिए अनुभाग कमांड देखें।