Skip to content

Commit

Permalink
ci: check doxygen script works on PR and fix doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillaumeLaine committed Feb 27, 2024
1 parent 09e9d15 commit 99b0a8e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
20 changes: 19 additions & 1 deletion .github/workflows/doxygen-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ on:
branches:
- main
- doxygen
pull_request:
branches:
- "*"

jobs:
deploy:
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/doxygen'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand All @@ -24,4 +28,18 @@ jobs:
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html
publish_dir: ./docs/html

check-doxygen:
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: Install Doxygen
run: sudo apt update && sudo apt install -y doxygen

- name: Run Doxygen
run: ./scripts/run-doxygen.sh
8 changes: 4 additions & 4 deletions px4_ros2_cpp/include/px4_ros2/utils/geodesic.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ static inline Eigen::Vector3f vectorToGlobalPosition(
*
* @param global_position_line_start line start lat [deg], lon [deg]
* @param global_position_line_end line end lat [deg], lon [deg]
* @param dist distance [m] of target global position from position 'start' towards position 'end' (can be negative)
* @param dist_from_start distance [m] of target global position from position 'start' towards position 'end' (can be negative)
*
* @ingroup geodesic
*/
Expand All @@ -239,7 +239,7 @@ Eigen::Vector2d globalPositionFromLineAndDist(
*
* @param global_position_now current lat [deg], lon [deg]
* @param heading heading from the current position [rad] (clockwise)
* @param distance distance from the current position [m]
* @param dist distance from the current position [m]
* @return the target global position
*
* @ingroup geodesic
Expand All @@ -254,7 +254,7 @@ Eigen::Vector2d globalPositionFromHeadingAndDist(
*
* @param global_position_now current lat [deg], lon [deg]
* @param heading heading from the current position [rad] (clockwise)
* @param distance distance from the current position [m]
* @param dist distance from the current position [m]
* @return the target global position
*
* @ingroup geodesic
Expand Down Expand Up @@ -288,7 +288,7 @@ Eigen::Vector2d addVectorToGlobalPosition(
* @brief Compute the global position from adding a local frame vector to the current global position.
*
* @param global_position current lat [deg], lon [deg], alt AMSL [m]
* @param vector_ne local vector to add [m^3] (NED)
* @param vector_ned local vector to add [m^3] (NED)
* @return the resulting global position from the addition
*
* @ingroup geodesic
Expand Down

0 comments on commit 99b0a8e

Please sign in to comment.