Skip to content

Documentation generator using annotated sources for multiple computer languages

License

Notifications You must be signed in to change notification settings

copperspice/doxypress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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
  • Documents the following computer languages: C, C++, Objective-C, C#, Fortran, Java, IDL, Python, PHP, and TCL

Classes and Containers

  • DoxyPress links with the CopperSpice libraries
  • Removed all old Qt 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 modern C++ 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

Binary Files

DoxyPress prebuilt binaries are available for all supported platforms.

https://github.com/copperspice/doxypress/releases/ https://download.copperspice.com/doxypress/binary/

CopperSpice prebuilt binaries are available for all supported platforms.

https://github.com/copperspice/copperspice/releases/ https://download.copperspice.com/copperspice/binary/

System Requirements

Building DoxyPress requires a C++20 compiler and a C++20 standard library. You will also need a current copy of the CopperSpice libraries. DoxyPressApp links with CsCore and CsXml.

CMake build files are provided with the source distribution to build this application.

One additional requirement for building DoxyPress is the binary files for clang 18. The clang compiler must be built with RTTI enabled. Pre-built binary files are available for all supported platforms.

https://download.copperspice.com/doxypress/libClang/

Documentation

Full documentation for DoxyPress is available on the website or from our download page.

URL Description
https://www.copperspice.com/docs/doxypress/index.html Online
https://download.copperspice.com/doxypress/documentation Download (tar and zip formats)

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

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

Presentations

Our YouTube channel contains over 75 videos about C++, programming fundamentals, Unicode/Strings, multithreading, graphics, CopperSpice, DoxyPress, and other software development topics.

https://www.youtube.com/copperspice

Links to additional videos can be found on our website.

https://www.copperspice.com/presentations.html

Authors / Contributors

  • Ansel Sermersheim
  • Barbara Geller
  • Andrew Marlow
  • Adam Mensel
  • Tim van Deurzen
  • Robert Jamnitzky

License

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

References