Hi All,

I published a doxygen documentation for the mynewt C source
It is generated with html output selected for the whole master branch of 
apache/mynewt-core, but without any diagrams. 
I use it for exploring the source if I’m not in front of my Mac, e.g. on an 
iPad ;-)

You can find it here: http://mynewt.w3y.de

Before starting the doxygen  I had to modify some files:
renamed /net/ip/lwip_base/doc/doxygen/main_page.h to 
/net/ip/lwip_base/doc/doxygen/main_page.h-disabled (otherwise interferes with 
doxygen)
removed oxygen keyword  \mainpage in /hw/cmsis-core/src/ext/arm_math.h 
(otherwise interferes with doxygen)
added a file examples.h in apps folder to define the entries for example list
To set the name in the index for a README.md file there should be a level one 
header in the first line, above the license text.
# Flash circular buffer
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
to define the root README.md as the index.html page I had to insert this at the 
top of the file:
Mynewt Overview                         {#mainpage}
===============

NOTE: The doxyfile is configured to exclude all folders in hw/mcu except native 
and nordic.

The output could be improved a lot if some of the oxygen tags would be used in 
the source.
I think the time would be a good investment in the accessibility of mynewt. 
It’s my first try of this tool so I don’t know (yet) the details.

The total size is 280 MB of generated html, js and css files, about 10000 files 
The generation on macbook pro takes less than a minute,
but needs 45 minutes to upload to my web space provider :-)

It’s a bit cumbersome that oxygen generates always a pair of files, one for 
„file reference" and one for "source code".
Especially for the yml-files this makes no sense.

Regards
Alfred

Reply via email to