Skip to content

Commit 327733e

Browse files
Additional cleanup
1 parent caa8ffd commit 327733e

1 file changed

Lines changed: 1 addition & 10 deletions

File tree

scripts/generate-docs.sh

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ elif [[ -z "$project_number" ]]; then
8282
fi
8383

8484
# git describe emits "<tag>-<n>-g<sha>[-dirty]"
85-
# Strip unneeded "g" so it's easier to read.
85+
# Strip unneeded "g" so it's easier to read
8686
if [[ "$described" =~ ^(.+-[0-9]+)-g([0-9a-f]+)(.*)$ ]]; then
8787
described="${BASH_REMATCH[1]}-${BASH_REMATCH[2]}${BASH_REMATCH[3]}"
8888
fi
@@ -111,15 +111,6 @@ fi
111111
echo "==> Building Doxygen docs with PROJECT_NUMBER=${project_number}"
112112
cd "$repo_root"
113113

114-
# Doxygen owns the failure decision: docs/doxygen/Doxyfile sets
115-
# WARN_IF_UNDOCUMENTED = NO (silences the ~400 "X is not documented"
116-
# warnings about internal/private symbols)
117-
# WARN_AS_ERROR = FAIL_ON_WARNINGS
118-
# so any remaining warning (broken @ref, unknown @-command, unsupported HTML
119-
# tag, malformed table, unreadable INPUT entry, etc.) fails this script via a
120-
# non-zero exit. There is no per-warning toggle in Doxygen; if a category
121-
# becomes too noisy to enforce, mute it at the WARN_IF_* level in the Doxyfile
122-
# rather than adding pattern allowlists here.
123114
LIVEKIT_DOXYGEN_PROJECT_NUMBER="$project_number" doxygen docs/doxygen/Doxyfile
124115

125116
docs_index="${repo_root}/docs/doxygen/html/index.html"

0 commit comments

Comments
 (0)