doxygen_manual-1.8.1 (1035109), страница 19
Текст из файла (страница 19)
I have problems getting the search engine to work with PHP5 and/or windowsPlease read this for hints on where to look.17. Can I configure doxygen from the command line?Not via command line options, but doxygen can read from stdin, so you can pipe things through it. Here’san example how to override an option in a configuration file from the command line (assuming a UNIXenvironment):( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen Generated by Doxygen80Frequently Asked QuestionsFor Windows the following would do the same:( type Doxyfile & echo PROJECT_NUMBER=1.0 ) | doxygen.exe -If multiple options with the same name are specified then doxygen will use the last one.
To append to anexisting option you can use the += operator.18. How did doxygen get its name?Doxygen got its name from playing with the words documentation and generator.documentation -> docs -> doxgenerator -> genAt the time I was looking into lex and yacc, where a lot of things start with "yy", so the "y" slipped in and madethings pronounceable (the proper pronouncement is Docs-ee-gen, so with a long "e").19. What was the reason to develop doxygen?I once wrote a GUI widget based on the Qt library (it is still available at http://qdbttabular.sourceforge.net/ and maintained by Sven Meyer). Qt had nicely generated documentation (usingan internal tool which they didn’t want to release) and I wrote similar docs by hand. This was a nightmareto maintain, so I wanted a similar tool. I looked at Doc++ but that just wasn’t good enough (it didn’t supportsignals and slots and did not have the Qt look and feel I had grown to like), so I started to write my own tool...Generated by DoxygenChapter 16TroubleshootingKnown problems:• If you have problems building doxygen from sources, please read this section first.• Doxygen is not a real compiler, it is only a lexical scanner.
This means that it can and will not detect errors inyour source code.• Since it is impossible to test all possible code fragments, it is very well possible, that some valid piece of C/C++ code is not handled properly. If you find such a piece, please send it to me, so I can improve doxygen’sparsing capabilities. Try to make the piece of code you send as small as possible, to help me narrow downthe search.• Doxygen does not work properly if there are multiple classes, structs or unions with the same name in yourcode.
It should not crash however, rather it should ignore all of the classes with the same name except one.• Some commands do not work inside the arguments of other commands. Inside a HTML link (i.e. <ahref="...">...<a>) for instance other commands (including other HTML commands) do not work! The sectioning commands are an important exception.• Redundant braces can confuse doxygen in some cases. For example:void f (int);is properly parsed as a function declaration, butconst int (a);is also seen as a function declaration with name int, because only the syntax is analyzed, not the semantics.If the redundant braces can be detected, as inint *(a[20]);then doxygen will remove the braces and correctly parse the result.• Not all names in code fragments that are included in the documentation are replaced by links (for instancewhen using SOURCE_BROWSER = YES) and links to overloaded members may point to the wrong member.This also holds for the "Referenced by" list that is generated for each function.For a part this is because the code parser isn’t smart enough at the moment.
I’ll try to improve this inthe future. But even with these improvements not everything can be properly linked to the correspondingdocumentation, because of possible ambiguities or lack of information about the context in which the codefragment is found.• It is not possible to insert a non-member function f in a class A using the \relates or \relatesalso command, ifclass A already has a member with name f and the same argument list.• There is only very limited support for member specialization at the moment. It only works if there is a specialized template class as well.82Troubleshooting• Not all special commands are properly translated to RTF.• Version 1.8.6 of dot (and maybe earlier versions too) do not generate proper map files, causing the graphsthat doxygen generates not to be properly clickable.• PHP only: Doxygen requires that all PHP statements (i.e.
code) is wrapped in a functions/methods, otherwiseyou may run into parse problems.How to helpThe development of Doxygen highly depends on your input!If you are trying Doxygen let me know what you think of it (do you miss certain features?). Even if you decide not touse it, please let me know why.How to report a bugBugs are tracked in GNOME’s bugzilla database. Before submitting a new bug, first search through thedatabase if the same bug has already been submitted by others (the doxygen product will be preselected).
If youbelieve you have found a new bug, please report it.If you are unsure whether or not something is a bug, please ask help on the users mailing list first (subscription is required).If you send only a (vague) description of a bug, you are usually not very helpful and it will cost me much more timeto figure out what you mean. In the worst-case your bug report may even be completely ignored by me, so alwaystry to include the following information in your bug report:• The version of doxygen you are using (for instance 1.5.3, use doxygen -version if you are not sure).• The name and version number of your operating system (for instance SuSE Linux 6.4)• It is usually a good idea to send along the configuration file as well, but please use doxygen with the -s flagwhile generating it to keep it small (use doxygen -s -u [configName] to strip the comments froman existing config file).• The easiest (and often the only) way for me to fix bugs is if you can attach a small example demonstrating theproblem you have to the bug report, so I can reproduce it on my machine.
Please make sure the example isvalid source code (could potentially compile) and that the problem is really captured by the example (I oftenget examples that do not trigger the actual bug!). If you intend to send more than one file please zip or tar thefiles together into a single file for easier processing. Note that when reporting a new bug you’ll get a chanceto attach a file to it only after submitting the initial bug description.You can (and are encouraged to) add a patch for a bug. If you do so please use PATCH as a keyword in the bugentry form.If you have ideas how to fix existing bugs and limitations please discuss them on the developers mailinglist (subscription required).
Patches can also be sent directly to dimitri@stack.nl if you prefer not to sendthem via the bug tracker or mailing list.For patches please use "diff -uN" or include the files you modified. If you send more than one file please tar or zipeverything, so I only have to save and download one file.Generated by DoxygenPart IIReference ManualChapter 17Features• Requires very little overhead from the writer of the documentation. Plain text will do, Markdown is support,and for more fancy or structured output HTML tags and/or some of doxygen’s special commands can be used.• Cross platform: works on Windows and many Unix flavors (including Linux and MacOSX).• Indexes, organizes and generates browsable and cross-referenced output even from undocumented code.• Generates structured XML output for parsed sources, which can be used by external tools.• Supports C/C++, Java, (Corba and Microsoft) Java, Python, VHDL, PHP IDL, C#, Fortran, TCL, Objective-C2.0, and to some extent D sources.• Supports documentation of files, namespaces, packages, classes, structs, unions, templates, variables, functions, typedefs, enums and defines.• JavaDoc (1.1), qdoc3 (partially), and ECMA-334 (C# spec.) compatible.• Comes with a GUI frontend (Doxywizard) to ease editing the options and run doxygen.
The GUI is availableon Windows, Linux, and MacOSX.• Automatically generates class and collaboration diagrams in HTML (as clickable image maps) and LATEX (asEncapsulated PostScript images).• Uses the dot tool of the Graphviz tool kit to generate include dependency graphs, collaboration diagrams,call graphs, directory structure graphs, and graphical class hierarchy graphs.• Allows grouping of entities in modules and creating a hierarchy of modules.• Flexible comment placement: Allows you to put documentation in the header file (before the declaration of anentity), source file (before the definition of an entity) or in a separate file.• Generates a list of all members of a class (including any inherited members) along with their protection level.• Outputs documentation in on-line format (XHTML and UNIX man page) and off-line format ( LATEX and RTF)simultaneously (any of these can be disabled if desired).
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
