Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/copperspice/doxypress
Documentation generator using annotated sources for multiple computer languages
https://github.com/copperspice/doxypress
copperspice cpp documentation-tool
Last synced: 2 days ago
JSON representation
Documentation generator using annotated sources for multiple computer languages
- Host: GitHub
- URL: https://github.com/copperspice/doxypress
- Owner: copperspice
- License: gpl-2.0
- Created: 2016-01-05T19:29:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-29T18:11:40.000Z (13 days ago)
- Last Synced: 2025-02-02T09:07:52.147Z (9 days ago)
- Topics: copperspice, cpp, documentation-tool
- Language: C++
- Homepage: https://www.copperspice.com/
- Size: 58.2 MB
- Stars: 155
- Watchers: 12
- Forks: 14
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 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
* Website: https://www.copperspice.com
* Twitter: https://twitter.com/copperspice_cpp
* Email: [email protected]
* Github: https://github.com/copperspice
* Forum: https://forum.copperspice.com
* Journal: https://journal.copperspice.com