diff --git a/.github/workflows/doxygen.yaml b/.github/workflows/doxygen.yaml new file mode 100644 index 00000000..72edf100 --- /dev/null +++ b/.github/workflows/doxygen.yaml @@ -0,0 +1,37 @@ +name: Deploy site + +on: + push: + branches: [ c3d-docs ] + +jobs: + doc-deploy: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + with: + persist-credentials: false + + - name: Set up Doxygen + run: sudo apt install doxygen + + - name: Display Doxygen version + run: echo "Doxygen version $(doxygen -v)" + + - name: Generate libctru tags + run: | + git clone --branch=master --single-branch --depth 1 https://github.com/devkitPro/libctru + cd libctru/libctru + doxygen + + - name: Build documentation + run: CTRU_DOCPATH="https://libctru.devkitpro.org/" doxygen + + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@3.7.1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages # The branch the action should deploy to. + FOLDER: docs/html # The folder the action should deploy. + CLEAN: true # Automatically remove deleted files from the deploy branch diff --git a/include/c3d/base.h b/include/c3d/base.h index d93132a1..e459125a 100644 --- a/include/c3d/base.h +++ b/include/c3d/base.h @@ -48,7 +48,7 @@ void C3D_BindProgram(shaderProgram_s* program); /** * @brief Sets the viewport for the current framebuffer. - * @note This value is modified by \ref C3D_FrameDrawOn(). (using values specified by \ref C3D_RenderTargetSetOutput()) + * @note This function is called by \ref C3D_FrameDrawOn(). (using values specified by \ref C3D_RenderTargetCreate()) * @note When using this with a rendertarget intended for display, keep in mind the orientation of the screens. * @param[in] x X offset from the origin of the viewport in pixels. * @param[in] y Y offset from the origin of the viewport in pixels.