Skip to content

Commit ba70b26

Browse files
committed
docs: use github actions for generating documentation
1 parent 02acc0e commit ba70b26

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

.github/workflows/doxygen.yaml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy site
2+
3+
on:
4+
push:
5+
branches: [ c3d-docs ]
6+
7+
jobs:
8+
doc-deploy:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v2
13+
with:
14+
persist-credentials: false
15+
16+
- name: Set up Doxygen
17+
run: sudo apt install doxygen
18+
19+
- name: Display Doxygen version
20+
run: echo "Doxygen version $(doxygen -v)"
21+
22+
- name: Generate libctru tags
23+
run: |
24+
git clone --branch=master --single-branch --depth 1 https://github.com/devkitPro/libctru
25+
cd libctru/libctru
26+
doxygen
27+
28+
- name: Build documentation
29+
run: CTRU_DOCPATH="https://libctru.devkitpro.org/" doxygen
30+
31+
- name: Deploy 🚀
32+
uses: JamesIves/[email protected]
33+
with:
34+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35+
BRANCH: gh-pages # The branch the action should deploy to.
36+
FOLDER: docs/html # The folder the action should deploy.
37+
CLEAN: true # Automatically remove deleted files from the deploy branch

include/c3d/base.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ void C3D_BindProgram(shaderProgram_s* program);
4848

4949
/**
5050
* @brief Sets the viewport for the current framebuffer.
51-
* @note This value is modified by \ref C3D_FrameDrawOn(). (using values specified by \ref C3D_RenderTargetSetOutput())
51+
* @note This function is called by \ref C3D_FrameDrawOn(). (using values specified by \ref C3D_RenderTargetCreate())
5252
* @note When using this with a rendertarget intended for display, keep in mind the orientation of the screens.
5353
* @param[in] x X offset from the origin of the viewport in pixels.
5454
* @param[in] y Y offset from the origin of the viewport in pixels.

0 commit comments

Comments
 (0)