Provide doxygen support

BigEd / python-on-a-chip

Automatically exported from code.google.com/p/python-on-a-chip

Other

1 stars 3 forks source link

Provide doxygen support #67

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago

The code, while mostly documented for use with doxygen, lacks a few tags
and makefile support. This issue involves adding support to generate
documentation from the source.

Original issue reported on code.google.com by bjones460@gmail.com on 2 Feb 2010 at 7:12

GoogleCodeExporter commented 9 years ago

r416 - Unmodified branch of the trunk. Forgot to add the matching log message 
(oops).

Original comment by bjones460@gmail.com on 2 Feb 2010 at 7:20

GoogleCodeExporter commented 9 years ago

r417 
- Added doxygen comments to VM C source
- Created a doxyfile
- Added a simple mainpage

Original comment by bjones460@gmail.com on 2 Feb 2010 at 7:56

GoogleCodeExporter commented 9 years ago

r428
- Added \brief comments to VM source
- Cleaned up stm32 comments
- Added doxygen support to makefile (thanks, Dean)
- Included reference to doxygen files from main index page
- Tweaked config to not report undocumented functions (way too many)

To do
- Get Python sources working with doxygen

Original comment by bjones460@gmail.com on 9 Feb 2010 at 7:55

GoogleCodeExporter commented 9 years ago

Update on including Doxygen support for Python modules:

The problem: the syntax
"""@package xxxx
... docstring ...
"""
to document a module only appears in Doxygen if it's the first thing in the 
file.
Even the line
#!/usr/bin/env python
or another Doxygen command such as
## @file
causes Doxygen NOT to include this string in the docs. Therefore, A significant 
chunk
of the existing documentation in Python modules disappears.

Work-arounds:
1. Duplicate the documentation in a doxygen-formatted string. Ugly, since the 
comment
may not be updated in both places.
2. Convert the package comments to Doxygen comments. Ugly because this breaks 
Python
help() functionality and Python coding style.

Original comment by bjones460@gmail.com on 10 Feb 2010 at 4:39

GoogleCodeExporter commented 9 years ago

r429
- Added Doxygen comments to Python source. Chose work-around #1 above for most 
cases,
since the documentation isn't lengthy.

Original comment by bjones460@gmail.com on 10 Feb 2010 at 7:25

GoogleCodeExporter commented 9 years ago

r434:
- Removed the Template_Project and the Modules tab
- Updated copyright date in doxygen_mainpage.h
- Updated link to doxgen index in docs/src/index.txt

Original comment by bjones460@gmail.com on 23 Feb 2010 at 10:31

GoogleCodeExporter commented 9 years ago

r435:
- Changed in the issue_0067_bjones_doxygen_support branch mainlined

Original comment by bjones460@gmail.com on 24 Feb 2010 at 7:16

GoogleCodeExporter commented 9 years ago

I checked out trunk and verified that html builds and tests pass.

Original comment by dwhall...@gmail.com on 24 Feb 2010 at 7:58

Changed state: Fixed
Added labels: Milestone-r10

GoogleCodeExporter commented 9 years ago

Changing Milestone-r10 to Milestone-r09

Original comment by dwhall...@gmail.com on 7 Mar 2010 at 6:26

Added labels: Milestone-r09

GoogleCodeExporter commented 9 years ago

Changed r09 to R09

Original comment by dwhall...@gmail.com on 12 Mar 2010 at 8:22

GoogleCodeExporter commented 9 years ago

Original comment by dwhall...@gmail.com on 13 Mar 2010 at 1:30

Added labels: Milestone-09