Commit 3c7191a9 authored by Ralph Giles's avatar Ralph Giles

Embed the git revision in the doxygen documentation.

The simple git-version script asks git for the current
revision, and falls back to 'unknown' if the result is
empty. This will have little effect until we have tags
in the repository.

We use the FILE_VERSION_FILTER option on doxygen to
embed this in the documentation with each file reference.

Unfortunately, there doesn't seem to be a way to
set PROJECT_NUMBER globally in the same way. This
commit unsets that option to avoid confusing references
in the generated documentation.
parent b8f50b4e
# Process with doxygen to generate API documentation
PROJECT_NAME = "opusfile"
PROJECT_NUMBER = unknown
PROJECT_NUMBER =
PROJECT_BRIEF = "Stand alone decoder library for .opus files."
INPUT = ../include/opusfile.h
OPTIMIZE_OUTPUT_FOR_C = YES
FILE_VERSION_FILTER = "/bin/sh git-version.sh"
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
......
#!/bin/sh
# script to build a version string
GIT_VERSION=$(git describe --tags --dirty 2> /dev/null)
if test -z ${GIT_VERSION}; then
VERSION='unknown'
else
VERSION=${GIT_VERSION}
fi
echo ${VERSION}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment