I have ported all of the documentation that is currently built with
maven to Markdown to make it possible to generate the single site with
Doxygen.  You can see the results here:
https://rm5248.com/log4cxx/apidocs/

Overall, this seems to be a much easier way to build the site and
documentation, since Doxygen is smart enough to link to class members
/ methods when they appear in the documentation, as opposed to having
to put a hardcoded link in the documentation(for example, the current
usage xml has a hardcoded link[1], while the markdown version only
requires you to write log4cxx::Logger::getRootLogger for the same link
to be generated)

At this point, I would propose that we do the following:
1. Merge this doxygen site into the main branch to make the website
and release creation easier.  As part of the documentation update, I
also added a target 'dist' that will tar/zip up the sources and sign
them at the same time, so it should be much easier than messing around
with maven.
2. Do a minor release(0.11.1) that contains the current fixes since
0.11.0(all in master at the moment):
* CMake updates to display path to test binaries
* OSX segfault
* Build without wchar
* Mapfilter chaining
* Intermediate directory creation for rolling files
3. (optional) remove the maven, ant, autotools files
4. document the release procedure(create a checklist) for the future
releases.  It is not as automated as maven is, but half of it is just
tagging and uploading the generated files to the correct place, so I
don't see it being a big issue to do manually.

Thoughts?

-Robert Middleton

[1]: 
https://github.com/apache/logging-log4cxx/blob/beb771eae0d7e8ee40067a969d8199ab9639982e/src/site/xdoc/usage.xml#L78

Reply via email to