Doxygen: Revision history

30 March 2020

• curprev 20:4420:44, 30 March 2020‎ Renatorivo talk contribs‎ 43,865 bytes +13‎ Marked this version for translation

29 March 2020

• curprev 23:3923:39, 29 March 2020‎ Vocx talk contribs‎ 43,852 bytes +20‎ Remove excessive spacing

21 February 2020

• curprev 17:4917:49, 21 February 2020‎ Kunda1 talk contribs‎ m 43,832 bytes −4‎ fix typo introduced in previous commit
• curprev 17:4717:47, 21 February 2020‎ Kunda1 talk contribs‎ m 43,836 bytes +82‎ Added {{TOCright}} + added 3rd Party category

20 February 2020

• curprev 22:2222:22, 20 February 2020‎ Renatorivo talk contribs‎ 43,754 bytes +46‎ No edit summary

26 December 2019

• curprev 16:4916:49, 26 December 2019‎ Renatorivo talk contribs‎ 43,708 bytes +39‎ Marked this version for translation
• curprev 16:4916:49, 26 December 2019‎ Renatorivo talk contribs‎ m 43,669 bytes +2‎ No edit summary

20 December 2019

• curprev 22:0122:01, 20 December 2019‎ Kunda1 talk contribs‎ m 43,667 bytes +98‎ Added Related section
• curprev 21:5921:59, 20 December 2019‎ Kunda1 talk contribs‎ m 43,569 bytes +38‎ Added some headers

26 September 2019

• curprev 13:5513:55, 26 September 2019‎ Mario52 talk contribs‎ 43,531 bytes +1,712‎ Marked this version for translation

16 August 2019

• curprev 16:2816:28, 16 August 2019‎ Vocx talk contribs‎ 41,819 bytes −11‎ →‎Doxygen with Python code: Changed all mentions of "double pound" symbols, to "double hash". Maybe that's less confusing.

26 July 2019

• curprev 22:3022:30, 26 July 2019‎ Vocx talk contribs‎ 41,830 bytes +319‎ →‎Converting the Pythonic style to Doxygen style: Added pyexample_doxygen.py (the top is manually edited, the rest stays the same)

24 July 2019

• curprev 00:2000:20, 24 July 2019‎ Vocx talk contribs‎ 41,511 bytes −17‎ →‎Markdown support: Use <pre> instead of Code template, to be able to use vertical lines | in the code example

20 July 2019

• curprev 18:3018:30, 20 July 2019‎ Vocx talk contribs‎ 41,528 bytes +830‎ →‎Compiling the documentation: Example from the VTK project.
• curprev 17:5717:57, 20 July 2019‎ Vocx talk contribs‎ 40,698 bytes +9‎ →‎Compiling the documentation: When generating the complete FreeCAD documentation, you don't run doxygen directly.
• curprev 05:4005:40, 20 July 2019‎ Vocx talk contribs‎ m 40,689 bytes +1‎ →‎Converting the comment style on the fly: Sentence ended with a dot
• curprev 05:4005:40, 20 July 2019‎ Vocx talk contribs‎ m 40,688 bytes −44‎ Sentence ended with a dot
• curprev 05:3905:39, 20 July 2019‎ Vocx talk contribs‎ 40,732 bytes +126‎ →‎Compiling the documentation: Image. General workflow to produce source code documentation with Doxygen.

19 July 2019

• curprev 04:3704:37, 19 July 2019‎ Vocx talk contribs‎ 40,606 bytes +137‎ →‎Compiling the documentation: Please also read the documentation tips located in the source code.
• curprev 04:3504:35, 19 July 2019‎ Vocx talk contribs‎ 40,469 bytes −362‎ →‎FreeCAD doxygen: The last "FreeCAD doxygen" section is not needed; that information is moved to the text discussing C++ sources
• curprev 04:0804:08, 19 July 2019‎ Vocx talk contribs‎ 40,831 bytes +202‎ →‎Converting the comment style on the fly: General workflow to produce source code documentation with Doxygen, when the Python files are filtered to transform the comment blocks
• curprev 03:4303:43, 19 July 2019‎ Vocx talk contribs‎ 40,629 bytes 0‎ Image 800px
• curprev 03:4103:41, 19 July 2019‎ Vocx talk contribs‎ 40,629 bytes +125‎ General workflow to produce source code documentation with Doxygen
• curprev 00:3400:34, 19 July 2019‎ Vocx talk contribs‎ 40,504 bytes +1,119‎ →‎FreeCAD doxygen: New section "Source documentation with Sphinx" with a different approach of creating the documentation
• curprev 00:0400:04, 19 July 2019‎ Vocx talk contribs‎ 39,385 bytes +259‎ →‎Python code quality check: Small changes in redaction

18 July 2019

• curprev 23:5023:50, 18 July 2019‎ Vocx talk contribs‎ 39,126 bytes −13‎ →‎Converting the comment style on the fly: Small fixes in redaction
• curprev 23:4223:42, 18 July 2019‎ Vocx talk contribs‎ 39,139 bytes +29‎ →‎Converting the comment style on the fly: Fixed the internal links and small details
• curprev 22:5722:57, 18 July 2019‎ Vocx talk contribs‎ 39,110 bytes −2‎ →‎Conversion of commenting style on the fly: Renamed "Converting the comment style on the fly"
• curprev 22:5622:56, 18 July 2019‎ Vocx talk contribs‎ m 39,112 bytes +3‎ →‎Convert the Pythonic style to Doxygen style
• curprev 22:5322:53, 18 July 2019‎ Vocx talk contribs‎ 39,109 bytes +1‎ →‎Convert the Pythonic style to Doxygen style: New output from doxypypy
• curprev 22:5122:51, 18 July 2019‎ Vocx talk contribs‎ 39,108 bytes −23‎ →‎Convert the Pythonic style to Doxygen style: Code compliant with
• curprev 22:4822:48, 18 July 2019‎ Vocx talk contribs‎ 39,131 bytes +89‎ →‎Convert the Pythonic style to Doxygen style: Therefore, add the directory to the PATH variable, either in your $HOME/.bashrc file, or in your $HOME/.profile file.
• curprev 22:3222:32, 18 July 2019‎ Vocx talk contribs‎ 39,042 bytes −11‎ →‎Second style: documentation block before the code: Refactored code to comply with "flake8", with no warnings, except or the double pound symbols ##
• curprev 22:2622:26, 18 July 2019‎ Vocx talk contribs‎ 39,053 bytes −4‎ →‎First style: Pythonic documentation: Refactored code so it complies with "flake8" with no warnings
• curprev 21:4921:49, 18 July 2019‎ Vocx talk contribs‎ 39,057 bytes +331‎ →‎Doxygen markup: Collapsed content
• curprev 21:4421:44, 18 July 2019‎ Vocx talk contribs‎ 38,726 bytes +28‎ →‎Doxygen with Python code: There are two ways to write documentation blocks for Python:
• curprev 19:0419:04, 18 July 2019‎ Vocx talk contribs‎ 38,698 bytes +1,602‎ →‎Conversion of commenting style on the fly: Python code quality check, more information on the different tools, including flake8, pycodestyle and pydocstyle
• curprev 17:5617:56, 18 July 2019‎ Vocx talk contribs‎ m 37,096 bytes +10‎ →‎Conversion of commenting style on the fly
• curprev 17:1217:12, 18 July 2019‎ Vocx talk contribs‎ 37,086 bytes +1,185‎ →‎Conversion of commenting style on the fly: Ideally we want this conversion to occur automatically, on the fly, with any number of Python files.
• curprev 16:4016:40, 18 July 2019‎ Vocx talk contribs‎ 35,901 bytes +33‎ →‎Convert the Pythonic style to Doxygen style: Change the names to "pyexample_pythonic.py" and "pyexample_doxygen.py" for better understanding
• curprev 16:3116:31, 18 July 2019‎ Vocx talk contribs‎ 35,868 bytes +955‎ →‎Conversion on the fly: With this configuration done, the doxygen Doxyfile command can be run to generate the documentation. Every Python file which uses Pythonic '''triple quotes''' will be reformatted on the fly to use ##Doxygen style comments,
• curprev 15:2215:22, 18 July 2019‎ Vocx talk contribs‎ 34,913 bytes +46‎ →‎Convert the Pythonic style to Doxygen style: Details
• curprev 06:4106:41, 18 July 2019‎ Vocx talk contribs‎ 34,867 bytes +105‎ →‎Conversion on the fly: In the previous example, the conversion was done manually with only one file. Naturally, we want Doxygen to perform the conversion automatically, on the fly, with any number of Python files.
• curprev 06:3606:36, 18 July 2019‎ Vocx talk contribs‎ 34,762 bytes +229‎ →‎Convert the Pythonic style into Doxygen style: More information
• curprev 06:0906:09, 18 July 2019‎ Vocx talk contribs‎ 34,533 bytes +573‎ →‎Convert the Pythonic style into Doxygen style on the fly: New sections for the regular conversion, and for the "Conversion on the fly"
• curprev 05:0205:02, 18 July 2019‎ Vocx talk contribs‎ 33,960 bytes −9‎ →‎Convert the Pythonic style into Doxygen style on the fly: ##@package pyexample_c
• curprev 04:3904:39, 18 July 2019‎ Vocx talk contribs‎ 33,969 bytes +64‎ →‎Convert the Pythonic style into Doxygen style on the fly: Update the code
• curprev 02:5102:51, 18 July 2019‎ Vocx talk contribs‎ 33,905 bytes +497‎ →‎Convert the Pythonic style into Doxygen style on the fly: Internal links to Doxygen and Pythonic styles sections
• curprev 02:3302:33, 18 July 2019‎ Vocx talk contribs‎ 33,408 bytes +152‎ →‎Compiling the documentation: The documentation should show similar information to the following, and create appropriate links to the individual modules and classes.
• curprev 02:3102:31, 18 July 2019‎ Vocx talk contribs‎ 33,256 bytes −8‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: Renamed section "Convert the Pythonic style into Doxygen style on the fly"
• curprev 02:2902:29, 18 July 2019‎ Vocx talk contribs‎ 33,264 bytes +670‎ →‎Second style: documentation block before the code: Compiling the documentation for Python sources is the same as for C++ sources
• curprev 02:0702:07, 18 July 2019‎ Vocx talk contribs‎ 32,594 bytes +2‎ →‎Second style: documentation block before the code: Make sure the code is not missing spaces
• curprev 02:0602:06, 18 July 2019‎ Vocx talk contribs‎ 32,592 bytes +2‎ →‎First style: Pythonic documentation: Make sure the code example isn't missing any space
• curprev 02:0402:04, 18 July 2019‎ Vocx talk contribs‎ 32,590 bytes +12‎ →‎Doxygen with Python code: in this case double pound characters ## should start the documentation block,
• curprev 02:0002:00, 18 July 2019‎ Vocx talk contribs‎ 32,578 bytes +98‎ →‎Markdown support: Splitting Markdown standard and extensions
• curprev 01:5601:56, 18 July 2019‎ Vocx talk contribs‎ m 32,480 bytes +1‎ →‎Compiling the documentation: and
• curprev 01:4801:48, 18 July 2019‎ Vocx talk contribs‎ 32,479 bytes +2‎ →‎First style: Pythonic documentation: @package pyexample_a
• curprev 01:4701:47, 18 July 2019‎ Vocx talk contribs‎ 32,477 bytes +2‎ →‎Second style: documentation block before the code: @package pyexample_b
• curprev 01:4401:44, 18 July 2019‎ Vocx talk contribs‎ 32,475 bytes +1‎ →‎Second style: documentation block before the code: Space before the function comment block.
• curprev 01:3601:36, 18 July 2019‎ Vocx talk contribs‎ 32,474 bytes +42‎ →‎Compiling the documentation: Internal links to Markdown and special commands
• curprev 00:3700:37, 18 July 2019‎ Vocx talk contribs‎ 32,432 bytes +436‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: More information
• curprev 00:1000:10, 18 July 2019‎ Vocx talk contribs‎ 31,996 bytes +1‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: mkdir -p $HOME/bin
• curprev 00:1000:10, 18 July 2019‎ Vocx talk contribs‎ 31,995 bytes +18‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: mkdir p $HOME/bin

17 July 2019

• curprev 23:3023:30, 17 July 2019‎ Vocx talk contribs‎ 31,977 bytes +323‎ →‎Doxygen with Python code: Information about Sphinx, which is the most common documentation tool for Python code.
• curprev 23:1023:10, 17 July 2019‎ Vocx talk contribs‎ 31,654 bytes 0‎ Moved the "Markdown" and "Parsing" sections before the "Python" sections, as the Python code requires a closer attention.
• curprev 23:0823:08, 17 July 2019‎ Vocx talk contribs‎ 31,654 bytes +2,479‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: More information on using the FILTER_PATTERNS tag to convert on the fly the source files
• curprev 20:4620:46, 17 July 2019‎ Vocx talk contribs‎ m 29,175 bytes 0‎ →‎Option: convert the Pythonic style into Doxygen style on the fly
• curprev 20:4420:44, 17 July 2019‎ Vocx talk contribs‎ 29,175 bytes +3‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: The program outputs the new file to standard output, so this output is just redirected to a new file.
• curprev 20:4320:43, 17 July 2019‎ Vocx talk contribs‎ 29,172 bytes +1‎ →‎Option: convert the Pythonic style into Doxygen style on the fly
• curprev 20:4120:41, 17 July 2019‎ Vocx talk contribs‎ 29,171 bytes +2‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: Pythonic docstrings
• curprev 18:4018:40, 17 July 2019‎ Vocx talk contribs‎ 29,169 bytes +257‎ →‎Option: convert the Pythonic style into Doxygen style on the fly: Example, and filtered file
• curprev 18:3818:38, 17 July 2019‎ Vocx talk contribs‎ 28,912 bytes +3,686‎ →‎Second style: documentation block before the code: New section "Option: convert the Pythonic style into Doxygen style on the fly"
• curprev 17:4117:41, 17 July 2019‎ Vocx talk contribs‎ m 25,226 bytes −3‎ →‎Doxygen markup
• curprev 17:3817:38, 17 July 2019‎ Vocx talk contribs‎ 25,229 bytes +626‎ →‎Compiling the documentation: When generating the FreeCAD documentation, you don't run doxygen directly. Instead, the project uses cmake to configure the build environment, and then make triggers compilation of the Doxygen documentation.
• curprev 15:3515:35, 17 July 2019‎ Vocx talk contribs‎ 24,603 bytes −117‎ Don't translate yet
• curprev 15:3315:33, 17 July 2019‎ Vocx talk contribs‎ 24,720 bytes +188‎ <translate> and <language/>
• curprev 15:2115:21, 17 July 2019‎ Vocx talk contribs‎ 24,532 bytes +237‎ →‎Compiling the documentation: More details and translate guards
• curprev 14:4014:40, 17 July 2019‎ Vocx talk contribs‎ m 24,295 bytes 0‎ →‎First style: documentation block before the code: semi colon
• curprev 14:3614:36, 17 July 2019‎ Vocx talk contribs‎ 24,295 bytes +83‎ →‎Doxygen with C++ code: More complete information
• curprev 14:1114:11, 17 July 2019‎ Vocx talk contribs‎ 24,212 bytes −39‎ This document gives a brief introduction to Doxygen, in particular how it is used in FreeCAD to document its sources. Visit the source documentation page for instructions on building the FreeCAD documentation, which is also hosted on the FreeCAD API site
• curprev 04:2204:22, 17 July 2019‎ Vocx talk contribs‎ 24,251 bytes +29‎ →‎Compiling the documentation: Link to Graphviz
• curprev 04:1504:15, 17 July 2019‎ Vocx talk contribs‎ 24,222 bytes +239‎ Visit the source documentation page for instructions on building the FreeCAD programming documentation. A version of this documentation is hosted online on the FreeCAD API website.
• curprev 04:0704:07, 17 July 2019‎ Vocx talk contribs‎ 23,983 bytes +268‎ →‎Compiling the documentation: Enclose in collapsible elements to view on demand
• curprev 03:5403:54, 17 July 2019‎ Vocx talk contribs‎ 23,715 bytes +2,825‎ →‎Doxygen markup: New section describing the compilation with Doxygen
• curprev 02:1602:16, 17 July 2019‎ Vocx talk contribs‎ 20,890 bytes −97‎ →‎Markdown support: Some examples of Markdown formatting are presented next.
• curprev 02:1302:13, 17 July 2019‎ Vocx talk contribs‎ 20,987 bytes +6‎ →‎Second style: documentation block before the code: and there is one block after a class variable
• curprev 02:1302:13, 17 July 2019‎ Vocx talk contribs‎ 20,981 bytes +59‎ →‎Second style: documentation block before the code: In the following example the documentation blocks start with a double pound sign ##.
• curprev 02:1102:11, 17 July 2019‎ Vocx talk contribs‎ 20,922 bytes +35‎ →‎First style: Pythonic documentation: In the following example one docstring is at the beginning to explain the general contents of this module (file).
• curprev 02:0902:09, 17 July 2019‎ Vocx talk contribs‎ 20,887 bytes +2,366‎ →‎Parsing of documentation blocks: Information on Markdown support, new in Doxygen 1.8

16 July 2019

• curprev 23:3423:34, 16 July 2019‎ Vocx talk contribs‎ 18,521 bytes −20‎ →‎Parsing of documentation blocks: Small changes
• curprev 23:1623:16, 16 July 2019‎ Vocx talk contribs‎ 18,541 bytes +19‎ →‎First style: Pythonic documentation: n this way, Doxygen will extract the comments and present them as is, without modification.
• curprev 18:4418:44, 16 July 2019‎ Vocx talk contribs‎ 18,522 bytes +1,688‎ →‎Doxygen with Python code: Examples for the two documentation styles
• curprev 18:2718:27, 16 July 2019‎ Vocx talk contribs‎ 16,834 bytes +14‎ →‎Doxygen with Python code: Parentheses for the references
• curprev 05:5805:58, 16 July 2019‎ Vocx talk contribs‎ 16,820 bytes −3,117‎ →‎Example with the FreeCAD source code: This section, and the example file, are no longer needed as better examples are given in the previous section
• curprev 05:5605:56, 16 July 2019‎ Vocx talk contribs‎ 19,937 bytes +9‎ →‎Introduction: Renamed section "Doxygen with C++ code"
• curprev 05:4305:43, 16 July 2019‎ Vocx talk contribs‎ 19,928 bytes +211‎ →‎Doxygen with Python code: Links to PEP8, PEP257, and some guides to write and document Python.
• curprev 05:2305:23, 16 July 2019‎ Vocx talk contribs‎ 19,717 bytes −4‎ →‎Second style: documentation block elsewhere: Example src/Base/core-base.dox; this file in FreeCAD's source tree gives a short explanation of the Base namespace.
• curprev 02:5702:57, 16 July 2019‎ Vocx talk contribs‎ 19,721 bytes +174‎ \package indicates documentation for a Java package (but also used with Python).→‎Doxygen markup
• curprev 02:5402:54, 16 July 2019‎ Vocx talk contribs‎ 19,547 bytes +17‎ →‎Doxygen with Python code: More information on the two styles.
• curprev 02:5302:53, 16 July 2019‎ Vocx talk contribs‎ 19,530 bytes +290‎ →‎Doxygen with Python code: More information and link to the documentation