Skip to content

Commit

Permalink
Improve Doxygen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
azrogers committed Oct 25, 2024
1 parent b3f5ceb commit 78513e8
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 10 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
submodules: recursive
- name: Generate Documentation
run: |
npm install
cmake -B build -S .
cmake --build build --target cesium-native-docs
- name: Publish Documentation Artifact
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ endif()
include("cmake/defaults.cmake")

project(cesium-native
VERSION 0.1.0
VERSION 0.40.1
LANGUAGES CXX C
)

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Cesium Native powers Cesium's runtime integrations for [Cesium for Unreal](https
![Cesium Platform and Ecosystem](./doc/integration-ecosystem-diagram.jpg)
*<p align="center">A high-level Cesium platform architecture with the runtime integrations powered by Cesium Native and streaming content from Cesium ion.</p>*

### :card_file_box:Libraries Overview
### 🗃️Libraries Overview

| Library | Description |
| -- | -- |
Expand All @@ -34,7 +34,7 @@ Cesium Native powers Cesium's runtime integrations for [Cesium for Unreal](https
| **CesiumUtility** | Utility functions for JSON parsing, URI processing, etc. |


### :green_book:License
### 📗License

[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). Cesium Native is free for both commercial and non-commercial use.

Expand All @@ -46,7 +46,7 @@ Cesium Native powers Cesium's runtime integrations for [Cesium for Unreal](https
* CMake 3.15+
* For best JPEG-decoding performance, you must have [nasm](https://www.nasm.us/) installed so that CMake can find it. Everything will work fine without it, just slower.

### :rocket:Getting Started
### 🚀Getting Started

#### Clone the repo

Expand Down
15 changes: 13 additions & 2 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
find_package(Doxygen)

if (DOXYGEN_FOUND)
if(DOXYGEN_FOUND)
set(
LIB_DIRS
../Cesium3DTiles/include
Expand Down Expand Up @@ -39,7 +39,7 @@ if (DOXYGEN_FOUND)
../CesiumIonClient/test
../CesiumJsonReader/test
../CesiumJsonWriter/test
../CesiumQuantizedMeshTerrain/test
../CesiumQuantizedMeshTerrain/test
../CesiumRasterOverlays/test
../CesiumUtility/test
)
Expand All @@ -51,9 +51,20 @@ if (DOXYGEN_FOUND)
set(DOXYGEN_MACRO_EXPANSION YES)
set(DOXYGEN_EXPAND_ONLY_PREDEF YES)
set(DOXYGEN_PREDEFINED "CESIUM3DTILESSELECTION_API" "CESIUMGEOMETRY_API" "CESIUMUTILITY_API" "CESIUMGEOSPATIAL_API")
set(DOXYGEN_HTML_EXTRA_STYLESHEET "${CMAKE_CURRENT_LIST_DIR}/../node_modules/doxygen-awesome-css/doxygen-awesome.css")
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_DISABLE_INDEX NO)
set(DOXYGEN_FULL_SIDEBAR NO)
set(DOXYGEN_HTML_COLORSTYLE LIGHT)
set(DOXYGEN_SOURCE_BROWSER YES)
set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE "../README.md")
set(DOXYGEN_EXCLUDE_PATTERNS "*/node_modules/*")
set(DOXYGEN_IMAGE_PATH "./")

doxygen_add_docs(
cesium-native-docs
"../README.md"
${LIB_DIRS}
)
endif()
14 changes: 11 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
},
"homepage": "https://github.com/CesiumGS/cesium-native#readme",
"devDependencies": {
"clang-format": "^1.5.0"
"clang-format": "^1.5.0",
"doxygen-awesome-css": "https://github.com/jothepro/doxygen-awesome-css#v2.3.4"
}
}

0 comments on commit 78513e8

Please sign in to comment.