5/17/2023 0 Comments Compositor de la llorona![]() ![]() Make sure your Doxyfile contains GENERATE_XML = YES and XML_OUTPUT = xml.Document your code so that Doxygen can pick it up.You only need Doxygen, doxybook2 from this repository, and some markdown static site generator. build -target install -config MinSizeRel DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmakeĬmake -build. Vcpkg install -triplet 圆4-linux $(cat vcpkg.txt ) # Configure the project and use vcpkg toolchain ![]() # Install dependencies via vcpkg # The 'vcpkg.txt' file contains the list of dependencies to install # ensure you are using C++17 compiler # Linux: export CC=/usr/bin/gcc-9 C++17 compiler (for example: GCC-9 or Visual Studio 2017).To install from source, simply clone the repository, install the dependencies listed in the vcpkg.txt file, and use CMake + vcpkg toolchain to build it. The binary file doxybook2.exe is located in the bin folder in the zip file, put it somewhere in your system and add it to the OS PATH environment variable. The windows release needs Microsoft Visual C++ Redistributable for Visual Studio 2015, 20. Go to and download the precompiled binary in the zip file for your target platform. If using Windows, you will need Microsoft Visual C++ Redistributable for Visual Studio 2015, 20. No extra OS dependencies needed (everything is done via git vcpkg as linked statically), simply download the executable file from the GitHub release page. Windows arm64 is not tested and not supported at this moment. Doxygen 1.8.15 is supported but I do not recommend it. You will also need Doxygen 1.8.16 or newer. Using any other architecture, such as power PC, is not guaranteed to work. This tool has been compiled and tested on Windows (win32 and win64), Linux (amd64 and arm64), and OSX (amd64). Source markdown files for these examples above: Creating examples locallyįirst, compile the doxybook2 and then run examples.bat or examples.sh in the root folder of this repository. Feel free to submit an issue here on GitHub to let me know if you have found something. I can't catch all of those cases on my own. There will be some weird edge cases in which the markdown will not be properly generated. This project is not perfect and I will never claim it will be. ![]() If you don't want to bother with the templates, you can siply generate JSON only output (which contains partial Markdown for some things such as brief and detailed description), and use your own tool to create documentation you want. If you don't prefer the Markdown output generated by this tool, you can always make your own templates and supply them into this tool via the command line. The config file will help you to acomplish that by specifying the behavior or file names, relative links, etc. This project is not limited to only the static site generators listed here, you can use any other one. I have decided to created this next version (doxybook2) in C++ in order to get better memory usage, templating, and overall better customization. This project is a successor of doxybook which was a Python based tool that did the exact same thing. You can use the generated Markdown files to create beautiful C++ documentation using with MkDocs, GitBook, VuePress, Hugo, Docsify, or any other static site generator that supports markdown. This is a command line tool that converts Doxygen generated XML files into markdown files (or JSON). Screenshot taken from here Table of contents Also comes with an optional templating mechanism and extensive configuration file. Generate beautiful C++ documentation by converting Doxygen XML output into markdown pages via MkDocs, Hugo, VuePress, GitBook, Docsify, or your custom generator. HDoc - The modern documentation tool for C++įarewell and thank you to all contributors for fixing bugs and contributing with new functionality!ĭoxygen XML to Markdown (or JSON) converter.standardese - Standardese aims to be a nextgen Doxygen.m.css - A modern, mobile-friendly drop-in replacement for the stock Doxygen HTML output.Please also consider using the following alternatives: If anyone wishes to continue working on this project, please fork it and feel free to contact me (see my GitHub bio for contact details). ![]() Moreover, I have started to have a burnout programming. I am archiving this repository because I want to focus on other things in my life, and my free time has been occupied by other events. This project was started as a toy and I never expected it to become popular. I wish that I did a better job with the quality of the code, and mainly with maintaining it. This has been a great experience and it makes me happy that many of you have found this tool useful. I have decided to archive this repository. Doxybook2 Attention! Project has been archived! ![]()
0 Comments
Leave a Reply. |