bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-06-05 21:39:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

tools: Add make_cppdocs.sh for Linux/MacOS (see issue #3385)

Browse Source 
The make_distrib script will now generate Doxygen docs by default
if the doxygen command-line tool is installed. Run with `--no-docs`
(`--no-distrib-docs` with automate-git.py) to disable docs generation.
This commit is contained in:
Marshall Greenblatt
2022-09-02 11:22:42 -07:00
parent fa2464e843
commit 8645e88e0e
2 changed files with 47 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
tools/make_cppdocs.sh Executable file
View File

@ -0,0 +1,27 @@
#!/bin/bash
# Copyright (c) 2022 The Chromium Embedded Framework Authors. All rights
# reserved. Use of this source code is governed by a BSD-style license
# that can be found in the LICENSE file.
if ! command -v doxygen &> /dev/null
then
echo "ERROR: Please install Doxygen" 1>&2
exit 1
fi
# Determine the absolute path to the script directory.
SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
# Determine the top-level CEF directory.
CEF_DIR="${SCRIPT_DIR}/.."
# Environment variables inserted into the Doxyfile via `$(VAR_NAME)` syntax.
export PROJECT_NUMBER=$(python3 ${SCRIPT_DIR}/cef_version.py current)
# Generate documentation in the docs/html directory.
# Run from the top-level CEF directory so that relative paths resolve correctly.
( cd ${CEF_DIR} && doxygen Doxyfile )
# Write a docs/index.html file.
echo "<html><head><meta http-equiv=\"refresh\" content=\"0;URL='html/index.html'\"/></head></html>" > ${CEF_DIR}/docs/index.html