Developer Documentation

If you’re developing Graphitti code, then here are your reference documents.

Writing new code? Then make sure to follow our contributing guide and document your code here.

Reading code that isn’t obvious? When you figure out how it works, then document it here and document it in comments in the code.

Student Quick Start

Students, use this quickstart guide to help setup, use, and develop with Graphitti.

Software Development Process

• To further understand our development process, please check out our gitflow documentation.

• Your pull requests will not be approved if you do not adhere to our coding conventions.

Graphitti Repository Tools and Workflows

• CMake
  • Refer to the CMake documentation to help with any related CMake questions
• clang-format
  • Refer to the clang-format documentation to help with using this tool
• GitHub Pages
  • Refer to the GitHub Pages documentation section for an overview of how we use GitHub Pages and editing practices
• GitHub Actions Workflows
  • We have a Doxygen Action to regenerate the Doxygen documentation automatically
  • The GitHub Pages Action is another action ran along with the Doxygen one
  • Here is our plantUML Diagrams Action that regenerates our UML image documents

Graphitti System Documentation

• Diagrams
  • Here is a overview block UML diagram
  • Here is a list of UML class diagrams of Graphitti
  • Here are the sequence UML diagrams for the Graphitti system
• Doxygen
  • Documentation generated from source code
  • Doxygen provides web-based indices and hierarchical views of Graphitti’s class and file structures
  • Visit Doxygen Generated Documentation
  • Document code in the .h file using the Doxygen Style Guide format
  • Doxygen Update Guide
• Event buffering in vertex classes.
• Performing Analyses
• Neuro Implementation
• GraphManager and InputManager classes
• Configuration

---

« Go back to the Graphitti home page