Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get Travis CI working #1

Open
griswaldbrooks opened this issue Jul 24, 2016 · 2 comments
Open

Get Travis CI working #1

griswaldbrooks opened this issue Jul 24, 2016 · 2 comments

Comments

@griswaldbrooks
Copy link
Member

This branch needs to have the continuous integration up and running as it's soon to be production code.

@griswaldbrooks
Copy link
Member Author

Make sure doxygen is running as part of the build script.

@griswaldbrooks
Copy link
Member Author

griswaldbrooks commented Jul 26, 2016

These install doxygen and graphviz, which is used to generate the graphs.

sudo apt-get install doxygen
sudo apt-get install doxygen-gui
sudo apt-get install graphviz

Then to generate a doxygen config file called Doxyfile for the docs for a folder.

cd folder/with/code
doxygen -g

Then the file Doxyfile in folder/with/code needs to be edited.

nano Doxyfile

Change the project name. For example, for this directory I called it "Robot Application"

PROJECT_NAME = "Title for these Docs"

Change the output directory so it's not vomiting all over your directory.

OUTPUT_DIRECTORY = docs
NOTE: Traditionally documentation is not committed because of the bloat that it adds. Don't add it to your svn/git commits.

Enable recursion so it will go into folders to document them.

RECURSIVE = YES

Changes these values to document things that aren't correctly or normally documented using doxygen

EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_PACKAGE = YES
EXTRACT_STATIC = YES
EXTRACT_ANON_NSPACES = YES

Enable these to generate the call and inheritance graphs.

HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant