डॉक्सिजन एनोटेट सी ++ स्रोतों से दस्तावेज उत्पन्न करने के लिए वास्तविक वास्तविक उपकरण है, हालांकि, यह सी, ऑब्जेक्टिव-सी, सी #, हाइपरटेक्स्ट प्रीप्रोसेसर, जावा, पायथन, आईडीएल (कोरबा, माइक्रोसॉफ्ट, और यूएनओ / जैसी विभिन्न प्रसिद्ध प्रोग्रामिंग भाषाओं का भी समर्थन करता है। ओपनऑफिस फ्लेवर), फोरट्रान, वीएचडीएल और टीसीएल। यह लेख इस बारे में बताता है- "उबंटू पर डॉक्सिजन कैसे स्थापित करें"
Doxygen को स्थापित करने के लिए, निम्न कमांड का उपयोग करें -
$ sudo apt-get install doxygen
नमूना आउटपुट इस तरह होना चाहिए -
Reading package lists... Done Building dependency tree Reading state information... Done The following packages were automatically installed and are no longer required: libterm-readkey-perl linux-headers-4.4.0-31 linux-headers-4.4.0-31-generic linux-image-4.4.0-31-generic linux-image-extra-4.4.0-31-generic linux-signed-image-4.4.0-31-generic Use 'sudo apt autoremove' to remove them. The following additional packages will be installed: libclang1-3.6 libllvm3.6v5 libobjc-5-dev libobjc4 Suggested packages: doxygen-latex doxygen-doc doxygen-gui graphviz The following NEW packages will be installed: doxygen libclang1-3.6 libllvm3.6v5 libobjc-5-dev libobjc4 0 upgraded, 5 newly installed, 0 to remove and 26 not upgraded. Need to get 15.9 MB of archives. After this operation, 64.0 MB of additional disk space will be used. Do you want to continue? [Y/n] y Get:1 https://in.archive.ubuntu.com/ubuntu xenial/main amd64 libllvm3.6v5 amd64 1:3.6.2-3ubuntu2 [8,075 kB] Get:2 https://in.archive.ubuntu.com/ubuntu xenial-updates/main amd64 libobjc4 amd64 5.4.0-6ubuntu1~16.04.4 [111 kB] Get:3 https://in.archive.ubuntu.com/ubuntu xenial-updates/main amd64 libobjc-5-dev amd64 5.4.0-6ubuntu1~16.04.4 [380 kB] Get:4 https://in.archive.ubuntu.com/ubuntu xenial/main amd64 libclang1-3.6 amd64 1:3.6.2-3ubuntu2 [3,696 kB] Get:5 https://in.archive.ubuntu.com/ubuntu xenial/main amd64 doxygen amd64 1.8.11-1 [3,679 kB] .........................................................................................
Doxygen के बारे में अधिक जानकारी प्राप्त करने के लिए, निम्न कमांड का उपयोग करें -
$ doxygen --help
नमूना आउटपुट इस तरह होना चाहिए-
Doxygen version 1.8.11 Copyright Dimitri van Heesch 1997-2015 You can use doxygen in a number of ways: 1) Use doxygen to generate a template configuration file: doxygen [-s] -g [configName] If - is used for configName doxygen will write to standard output. 2) Use doxygen to update an old configuration file: doxygen [-s] -u [configName] 3) Use doxygen to generate documentation using an existing configuration file: doxygen [configName] If - is used for configName doxygen will read from standard input. 4) Use doxygen to generate a template file controlling the layout of the generated documentation: doxygen -l [layoutFileName.xml] 5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex. RTF: doxygen -w rtf styleSheetFile HTML: doxygen -w html headerFile footerFile styleSheetFile [configFile] LaTeX: doxygen -w latex headerFile footerFile styleSheetFile [configFile] 6) Use doxygen to generate a rtf extensions file RTF: doxygen -e rtf extensionsFile ........................................................................
स्रोत कोड का दस्तावेज़ीकरण उत्पन्न करने के लिए, निम्न कोड का उपयोग करें-
$ doxygen -g sample_text.conf
उपरोक्त कमांड में, इसने sample_text.conf . नामक एक फ़ाइल बनाई है जिसमें निम्न कोड है जैसा कि नीचे दिखाया गया है -
# Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- ..................................................................................
दस्तावेज़ तैयार करने के लिए, निम्न कमांड का उपयोग करें -
$ doxygen sample_text.conf
नमूना आउटपुट इस तरह होना चाहिए -
Searching for include files... Searching for example files... Searching for images... Searching for dot files... Searching for msc files... Searching for dia files... Searching for files to exclude Searching INPUT for files to process... Searching for files in directory /home/linux warning: source /home/linux/.dbus is not a readable file or directory... skipping. Reading and parsing tag files Parsing files Preprocessing /home/linux/abc.txt... Parsing file /home/linux/abc.txt... Preprocessing /home/linux/bbc.txt... Parsing file /home/linux/bbc.txt... Building group list... Building directory list... Building namespace list... Building file list... Building class list... Associating documentation with classes... Computing nesting relations for classes... Building example list... Searching for enumerations... Searching for documented typedefs... Searching for members imported via using declarations... Searching for included using directives... Searching for documented variables... Building interface member list... ................................................................
HTML-स्वरूपित दस्तावेज़ ब्राउज़ करने के लिए, निम्न आदेश का उपयोग करें -
$ cd html /html$ google-chrome index.html
नमूना आउटपुट इस तरह होना चाहिए -
इस लेख के बाद, आप समझ पाएंगे कि - उबंटू पर डॉक्सिजन कैसे स्थापित करें। अपने अगले लेखों में, हम और अधिक Linux आधारित ट्रिक्स और युक्तियों के साथ आएंगे। पढ़ते रहिये!