@@ -4,25 +4,14 @@ Dash or Zeal Docsets from Doxygen Documentation
4
4
Converts Doxygen Documentation to a [ Dash] ( https://kapeli.com/dash ) or
5
5
[ Zeal] ( https://zealdocs.org/ ) Docset.
6
6
7
- Building
8
- --------
7
+ Usage
8
+ -----
9
9
10
- Requirements: A C++ 14 compiler and CMake.
11
-
12
- * Make sure to pull submodules.
13
- ``` sh
14
- git submodule update --init --recursive
15
- ```
16
- * Configure the build system.
17
- ``` sh
18
- cmake -B build
19
- ```
20
- * Build the executable and tests.
21
- ``` sh
22
- cmake --build build
23
- ```
24
- * The executable is present in ` ./build/source/doxygen2docset ` .
25
- * The unit-test target is present in ` ./build/tests/doxygen2docset_unittests ` .
10
+ * [ Prepare your Doxygen docs] ( #preparing-project-doxyfile-for-docsets ) .
11
+ * Generate the Docset from the Doxygen generated docs using:
12
+ ```
13
+ doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
14
+ ```
26
15
27
16
Preparing Project Doxyfile for Docsets
28
17
--------------------------------------
@@ -39,14 +28,25 @@ Preparing Project Doxyfile for Docsets
39
28
* ` Tokens.xml `
40
29
* ` Info.plist `
41
30
42
- Generating Docset
43
- -----------------
31
+ Building
32
+ --------
44
33
45
- Generate the Docset from the Doxygen generated docs using:
34
+ Requirements: A C++ 14 compiler and CMake.
46
35
36
+ * Make sure to pull submodules.
37
+ ``` sh
38
+ git submodule update --init --recursive
39
+ ```
40
+ * Configure the build system.
41
+ ``` sh
42
+ cmake -B build
47
43
```
48
- doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
44
+ * Build the executable and tests.
45
+ ``` sh
46
+ cmake --build build
49
47
```
48
+ * The executable is present in ` ./build/source/doxygen2docset ` .
49
+ * The unit-test target is present in ` ./build/tests/doxygen2docset_unittests ` .
50
50
51
51
Options
52
52
-------
0 commit comments