rdkcentral / hal-doxygen Goto Github PK
View Code? Open in Web Editor NEWRDK Hardware Abstraction Layer common doxgen build and configuration
License: Apache License 2.0
RDK Hardware Abstraction Layer common doxgen build and configuration
License: Apache License 2.0
In Doxyfile.cfg, following needs to be changed:
Doxygen rendering requires below enhancements/fix :
spec needs some example statements to help engineering teams, basic ones to start with.
is currently pointing to develop, it should be main to ensure the template consumes official releases not work in progress.
new baseline code and clean up
Add support for checking the latest version and warning if not on it to be added to the clone script
https://github.com/rdkcentral/hal-doxygen/blob/develop/template/docs/generate_docs.sh
Something akin to the same one for ut-core
# Clone the Unit Test Requirements
[email protected]:rdkcentral/ut-core.git
# This function checks if we're not sitting on the latest revision.
function check_next_revision()
{
pushd ./ut-core 2&>/dev/null
# Set default UT_PROJECT_VERSION to next revision
if [ -v ${UT_PROJECT_VERSION} ]; then
UT_PROJECT_VERSION=$(git tag | grep ${UT_PROJECT_MAJOR_VERSION} | sort -r | head -n1)
UT_NEXT_VERSION=$(git tag | sort -r | head -n1)
echo -e ${YELLOW}ut-core version selected:[${UT_PROJECT_VERSION}]${NC}
if [ "${UT_NEXT_VERSION}" != "${UT_PROJECT_VERSION}" ]; then
echo -e ${RED}--- New Version of ut-core released [${UT_NEXT_VERSION}] consider upgrading ---${NC}
fi
fi
popd 2&>/dev/null
}
This sort of thing needs to be removed
# Set default UT_PROJECT_VERSION to master
if [ -z "${UT_PROJECT_VERSION}" ]; then
UT_PROJECT_VERSION=master
fi
Move documentation to github pages and set up a template for it.
Update Doxyfile.cfg:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.