From 1234619a4861d6129d79f6e8b781bd7c1eb799a6 Mon Sep 17 00:00:00 2001 From: Paul Novotny Date: Wed, 2 Nov 2016 20:56:04 -0400 Subject: [PATCH] Use CodeDocs for Doxygen documentation Adds a configuration file (.codedocs) for building the Doxygen documentation using CodeDocs.xyz. Also, adds a badge to the README.md to link to the documentation. --- .codedocs | 14 ++++++++++++++ README.md | 1 + 2 files changed, 15 insertions(+) create mode 100644 .codedocs diff --git a/.codedocs b/.codedocs new file mode 100644 index 000000000..661aff633 --- /dev/null +++ b/.codedocs @@ -0,0 +1,14 @@ +# CodeDocs.xyz Configuration File + +DOXYFILE = doc/Doxyfiles/doxyfile.cmake + +PROJECT_NUMBER = +PROJECT_LOGO = examples/osgAndroidExampleGLES1/res/drawable-hdpi/osg.png +INPUT = include \ + src \ + applications \ + examples +STRIP_FROM_PATH = include/ +HTML_FOOTER = +SEARCHENGINE = YES + diff --git a/README.md b/README.md index 70f2ab5cd..7e1526d14 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![Build Status](https://travis-ci.org/openscenegraph/OpenSceneGraph.svg?branch=master)](https://travis-ci.org/openscenegraph/OpenSceneGraph) [![Coverity Status](https://scan.coverity.com/projects/9159/badge.svg)](https://scan.coverity.com/projects/openscenegraph-openscenegraph) +[![Documentation](https://codedocs.xyz/openscenegraph/OpenSceneGraph.svg)](https://codedocs.xyz/openscenegraph/OpenSceneGraph/) ### Introduction