Skip to content

Documentation generation from annotated sources (multiple source languages)

License

Notifications You must be signed in to change notification settings

vdeurzen/doxypress

 
 

Repository files navigation

DoxyPress

Introduction

DoxyPress is a modern C++ application for generating documentation from annotated sources and API documentation. DoxyPress and DoxyPressApp were initially derived from Doxygen and DoxyWizard.

Major enhancements

Parsing

  • User selection for full parsing of C and C++ with clang in lieu of the legacy lex parser
  • Clang parser allows complicated modern C++ to be parsed accurately, especially as C++ is updated
  • Added a new parser for makefiles

Classes and Containers

  • DoxyPress links with the CopperSpice libraries
  • Removed all Qt 2 classes and containers
  • Refactored to use value based containers instead of pointer based containers
  • For improved memory management variadic templates and shared pointers are used
  • Source code reformatted for improved readability
  • Modified source code to use C++14 functionality, features, and syntax

Output

  • Project file format enhanced to use a JSON format for improved functionality
  • Command line option to convert Doxygen project files to the DoxyPress JSON format
  • Enhanced layout file to include new sections
  • Major improvements to the html output for correctness

System Requirements

To build DoxyPress you will need the CopperSpice libraries (CsCore, CsXml), a C++14 compiler, and a C++14 standard library.

Uses CMake or Autotools for building binary files.

Documentation

Full documentation for DoxyPress is available on the CopperSpice website:

www.copperspice.com/docs/doxypress/index.html

Building

For documentation on how to build the DoxyPress application refer to the following page:

www.copperspice.com/docs/doxypress/build-doxypress.html

Presentations

YouTube channel videos about CopperSpice, DoxyPress, C++, and the other topics related to our work.

https://www.youtube.com/copperspice

Links to technical presentations recorded at CppNow and CppCon:

www.copperspice.com/presentations.html

Authors / Contributors

  • Ansel Sermersheim
  • Barbara Geller
  • Andrew Marlow
  • Adam Mensel

License

This library is released under the GPL V2 license. For more information refer to the LICENSE file provided with this project.

References

About

Documentation generation from annotated sources (multiple source languages)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 94.1%
  • Lex 4.7%
  • JavaScript 0.3%
  • CSS 0.2%
  • Batchfile 0.1%
  • C 0.1%
  • Other 0.5%