doxygen_manual-1.8.1 (1035109)
Текст из файла
Manual for version 1.8.1Written by Dimitri van Heesch©1997-2012ContentsIUser Manual51Installation71.1Compiling from source on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71.2Installing the binaries on UNIX . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . .81.3Known compilation problems for UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91.4Compiling from source on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111.5Installing the binaries on Windows . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .111.6Tools used to develop doxygen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122Getting Started132.1Step 0: Check if doxygen supports your programming language . . . . . . . . . . . . . . . . . . .
.142.2Step 1: Creating a configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142.3Step 2: Running doxygen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152.3.1HTML output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162.3.2LaTeX output . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162.3.3RTF output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162.3.4XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . .162.3.5Man page output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16Step 3: Documenting the sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172.433.13.2Documenting the code19Special comment blocks . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193.1.119Comment blocks for C-like languages (C/C++/C#/Objective-C/PHP/Java) . . . . . . . . . . .3.1.1.1Putting documentation after members . . . . . . . . . . . . . . . . . . . . . . .213.1.1.2Examples223.1.1.3Documentation at other places.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . .243.1.2Comment blocks in Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263.1.3Comment blocks in VHDL . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . .273.1.4Comment blocks in Fortran . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .283.1.5Comment blocks in Tcl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29Anatomy of a comment block . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . .30444.1CONTENTSMarkdown33Standard Markdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334.1.1Paragraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . .334.1.2Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334.1.3Block quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .344.1.4Lists . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .344.1.5Code Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .344.1.6Horizontal Rulers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .354.1.7Emphasis . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .354.1.8code spans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .354.1.9Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .354.1.9.1Inline Links . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .354.1.9.2Reference Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .364.1.11 Automatic Linking . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37Markdown Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374.2.1Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . .374.2.2Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374.2.3Fenced Code Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374.2.4Header Id Attributes . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . .38Doxygen specifics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .384.3.1Including Markdown files as pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .384.3.2Treatment of HTML blocks. . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . .394.3.3Code Block Indentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394.3.4Emphasis limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. .404.3.5Code Spans Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .404.3.6Lists Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .404.3.7Use of asterisks . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .404.3.8Limits on markup scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41Debugging of problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .414.1.10 Images4.24.34.45Grouping435.1Modules . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .435.2Member Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .455.3Subpaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .476Including Formulas497Graphs and diagrams518Preprocessing55Generated by DoxygenCONTENTS95Automatic link generation599.1Links to web pages and mail addresses . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .599.2Links to classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .599.3Links to files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .599.4Links to functions.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .599.5Links to other members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .609.6typedefs . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . .6210 Output Formats6311 Searching6512 Customizing the Output6712.1Minor Tweaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6712.1.1 Overall Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . .6712.1.2 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6712.1.3 Dynamic Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6812.1.4 Header, Footer, and Stylesheet changes . . . . . . . . . . . . . . . . . . .
. . . . . . . . .6812.2Changing the layout of pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6912.3Using the XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7113 Custom Commands7313.1Simple aliases . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7313.2Aliases with arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7313.3Nesting custom command . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . .7414 Link to external documentation7515 Frequently Asked Questions7716 Troubleshooting81II83Reference Manual17 Features8518 Doxygen usage8718.187Fine-tuning the output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. .19 Doxywizard usage8920 Configuration9120.1Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9120.2Project related options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.93Generated by Doxygen6CONTENTS20.3Build related options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9620.4Options related to warning and progress messages . . . . . . . . . . . . . . . . . . . . . . . . . . .9920.5Input related options . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . .9920.6Source browsing related options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10120.7Alphabetical index options . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . 10120.8HTML related options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10220.9LaTeX related options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10620.10 RTF related options . . . . . . . . . .
Характеристики
Тип файла PDF
PDF-формат наиболее широко используется для просмотра любого типа файлов на любом устройстве. В него можно сохранить документ, таблицы, презентацию, текст, чертежи, вычисления, графики и всё остальное, что можно показать на экране любого устройства. Именно его лучше всего использовать для печати.
Например, если Вам нужно распечатать чертёж из автокада, Вы сохраните чертёж на флешку, но будет ли автокад в пункте печати? А если будет, то нужная версия с нужными библиотеками? Именно для этого и нужен формат PDF - в нём точно будет показано верно вне зависимости от того, в какой программе создали PDF-файл и есть ли нужная программа для его просмотра.