You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-6
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,17 @@
1
1
# Moxygen
2
2
3
-
Moxygen is a doxygen XML to markdown converter that fills the need for developers who have been craving a beautiful and minimal documentation alternative for their C++ projects.
3
+
Moxygen is a doxygen XML to markdown converter for developers who want a beautiful and minimal documentation solution for their C++ projects.
4
4
5
-
The code is a heavily modified port of `doxygen2md` with a focus on generating multi page documentation from doxygen [modules](http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#modules).
5
+
The code is based on `doxygen2md` with extra options for generating output files, custom templates, and generating multipage documentation.
6
6
7
-
Moxygen is the API documentation generator used by LibSourcey, the result of which can be seen[here](http://sourcey.com/libsourcey/).
7
+
Moxygen is currently used in conjunction with GitBook to generate the API documentation for LibSourcey, which can be viewed[here](http://sourcey.com/libsourcey/).
8
8
9
9
## Usage
10
10
11
-
1. Run `doxygen` to generate the XML documentation.
12
-
2. Run `moxygen` providing the folder location of the XML documentation.
13
-
11
+
1. Add `GENERATE_XML=YES` to your `Doxyfile` first.
12
+
2. Run `doxygen` to generate the XML documentation.
13
+
3. Install `moxygen` like so: `npm install moxygen -g`.
14
+
4. Run `moxygen` providing the folder location of the XML documentation as the first argument ie. `{OUTPUT_DIRECTORY}/xml`.
14
15
```
15
16
Usage: moxygen [options] <doxygen directory>
16
17
@@ -25,3 +26,15 @@ Moxygen is the API documentation generator used by LibSourcey, the result of whi
25
26
-t, --templates <dir> custom templates directory
26
27
-o, --output <file> output file (must contain %s when using modules)
27
28
```
29
+
30
+
## Multipage Output
31
+
32
+
Moxygen supports the doxygen [modules](http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#modules) syntax for generating multipage documentation.
33
+
34
+
Every [\defgroup](http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddefgroup) in your source code will be parsed and output into a separate markdown file, with internal reference updated accordingly.
0 commit comments