Codedocs will rebuild your documentation after every push and will give you a README badge as well. ![]() USE_MDFILE_AS_MAINPAGE = doc/main_page.mdĪfter this, all you have to do is enable your repository on the Codedocs website and you're good to go!. PROJECT_BRIEF = "A cross-platform C++14 project template" PROJECT_NAME = "Project Name" # <- These constants have to be hardcoded in # These variables have to be redefined since codedocs cannot run CMake Then, the following changes need to be made: DOXYFILE = doc/Doxyfile.in # We can reuse our Doxyfile codedocs file in the root of the repository. In order to set that up, we need to add a. The easiest tool to get your documentation up and running on a website is codedocs.xyz. In any of these files, if you have subsections (Created with section id Name), then you can add a table of contents using the tableofcontents command. USE_MDFILE_AS_MAINPAGE = subpage might looks as follows ( page_one.md): # Page One In order to make this file the main page of your documentation, you need to add the following in Doxyfile.in: INPUT =. This documentation is divided into the following sections:Įach of the subpage commands tells Doxygen to create a reference to the file with that ID. If you need to add extraneous documentation, such as these pages, you need a markdown structure similar to the following:įor your main page ( main_page.md): # Project Name In order to do so, a file Doxyfile.in is configured with many useful CMake variables from the file doc/CMakeLists.txt. src/external - a small collection of external code and headers.This project relies on Doxygen to generate its documentation.src/xrt/targets - glue code and build logic to produce final binaries.src/xrt/auxiliary - Auxiliary and other larger components, like Tracking and Math.src/xrt/state_trackers/gui - GUI Config Interface, various helper and debug GUI code.src/xrt/state_trackers/oxr - OpenXR state tracker, implements the OpenXR API.Comments may be placed anywhere within the file (except within quotes). The statements in the file are case-sensitive. The file may contain tabs and newlines for formatting purposes. src/xrt/compositor - Compositor code for doing distortion and driving the display hardware of a device. A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile, with the default name Doxyfile.src/xrt/include - XRT interfaces defines the internal interfaces of Monado.> I've got this line in the configuration file: > USEMDFILEASMAINPAGE RE. > And some contextual info, just in case it can be useful: > Windows 7 > Visual Studio 2012 > C > Doxygen version is 1.8.9.1. Here is the documentation for all XRT interfaces used to interact between modules. The message is > as follows: > README.md:1: warning: found more than one \mainpage comment block > Skipping this block. The key interfaces to begin learning Monado are: Understanding and Writing Targets: Connecting the Pieces - How the components of Monado ( xrt_instance, IPC, OpenXR, etc) are brought together for use.State Trackers consume implementations of these APIs provided by other modules. Monado is architected as a collection of loosely-coupled, internally cohesive components that interact through the internal, abstract "XRT" (XrRunTime) API. Code Style and Conventions - to help you both read and write Monado code.If you are viewing this on the web at, the changelog above also includes a section for changes that have not yet been in a tagged release. Please submit a merge request to fix any such issues you may notice.) ![]() (Since they are not maintained in the source code files directly, they may sometimes be slightly out-of-date, so in case of conflict, the code-based documentation is correct. See the "Related Pages" link above for a complete list of these non-code-based documentation pages. Some are linked below in a logical outline, and some documentation comments in code cross-reference these pages. There are also a number of pages in this site (including this one) that are maintained as fully human-authored Markdown files outside of source code files, but still in the repository in the doc/ directory. Figure 3.9 The main page of our documentation, consolidating both the generated and. (The directory structure matches the top levels of modules, but some are sub-divided further into sub-modules within a directory.) Now for the last part: merging Doxygen's output. These extracted documentation pages are best browsed through the "Modules" or "Files" links above. This documentation is maintained in part in documentation comments in the code itself, extracted and rendered by Doxygen. It also assumes that you have read README.md: that file also holds getting started information and general documentation. This documentation is intended for developers wanting to dive into the code of Monado.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |