Use to initaiate italic type and to close it.Use to initiate boldface and to close it.With any other format, they will be ignored or may cause unwanted effects. Note: the following keywords work only when the selected output format is HTML. If you already know HTML, you may skip the following section. So finally we will deal a little bit with HTML. But especially this intro page must look perfect - in Germany we say: the first impression is always the most formative! The magic word here is and is followed by an description of the project. * A short description of the file - what does it contain, what is it's purpose. * You can force new lines in the HTML documentation with īut important is, to leave no blank line between comment block and code segment.Ī typical Doxygen comment looks like this: This can be a function, variable, structure. There mustn't be any spaces or other characters, before this asterisks!Īfter the comment block follows the associated code segment. The double asterisk is used by Doxygen to differ from common multi-line comments.įurthermore all lines of comment should start with an asterisk. This is the typical syntax for Doxygen comments. Well, but function and purpose don't matter now - let's have a look at the documentation.Īs already mentioned, Doxygen uses a special format of comments and if you look at the source code you'll find some comments, To run the program you need the Java Runtime Environment (JRE) from Sun Microsystems. It uses selectionsort, insertionsort and Bubblesort algortihms and compares execution times. This is a Java program to sort arrays of integer with different sorting algorithms. This html folder then contains a "index.html".Īnd in the following we will have a more detailed look at this.įor demonstration, here is a exemplary Java project for download:Īnd here the associated HTML documentation for direct view in your browser: To check this just open a console window (Start->Execute->"cmd"), enter PATH and search the result for something like "C:\Program files\doxygen\bin".īy pressing "Start" Doxygen now generates the documentation in a subfolder "html" in your project folder. (this is the path to the Doxygen binaries) - I found out, that you can enter any valid path (for instance C:\) here as long as Doxygen has been Now you should save this settings in a Doxyfile, because you certainly don't like to repeat all this steps again next time.Ĭlick "Save." in the main window and store the Doxyfile in the project folder.įinally there is one thing left, which Doxygen wants to know: in Working directory you must enter the path, from where Doxygen starts When everything looks fine, confirm with "OK" and once again we go back to the expert mode and select English from OUTPUT_LANGUAGE in the tab "Project". Last but not least we have a look at the tab "Diagrams" and verify if the setting look like this: Select the tab "Output" and deactivate the LaTex option - excepting you also like to get a documentation in the LaTex format. Now switch to the tab "Mode" and select the code language at "Select programming language to optimize the results for" (C, C++ or Java). This Folder should also used for Destination directory - Doxygen then creates a new subfolder "html", containing the generated documentation. Then specify the path to the code files at Source code directory. Click "Wizard." and you will be asked for a project name.Įnter the project name and give it a version number - for instance "Version 1.0". So, jetzt mit Klick auf "OK" die Einstellungen übernehmen. Select "HAVE_DOT" and enter the path to the Graphiz binaries.ĭon't use backslashes '\', but normal slashes '/' in the Graphiz path. Here you need to tell Doxygen that Graphiz has been installed and the path to Graphviz. Graphviz needs no configuration, but Doxygen does.Ĭlick "Expert." in the Doxygen Wizard and select the tab "Dot". We should install Doxygen first, then Graphviz. Graphviz DOT is a small plug-in for Doxygen, which allows graphical outputs, but later more about this. So, let's have a look to installation and configuration of Doxygen.įirst of all, we need to download Doxygen (5.4 MB). Well, and this is the point where Doxygen is used. You even may have yourself difficulties to comprehend your own code after a time.īeside the commenting of the code, it is also often necessary to document the project.Ī documentation is used for presentation, makes it easy for non-programmers to get familiar with the software and is something you can hand out once the project is finished. If you don't comment your code, you make it very difficult for other software engineers to understand your program. Printf( "Hello World\n") //This is a comment in a single line
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |