diff options
| author | Levent Kaya <levent.kaya@codefirst.io> | 2024-11-24 13:49:12 +0300 |
|---|---|---|
| committer | Levent Kaya <levent.kaya@codefirst.io> | 2024-11-24 13:49:12 +0300 |
| commit | c4b982cf5a6d89fee18237645b59274d41d0d7e6 (patch) | |
| tree | 97a93fc5124bd7469d3645c1f32774d27f59f536 | |
| parent | 25d7a0decd62f3cc5a1812896dcb03348fd866e6 (diff) | |
[docs] doxygen gh page
| -rw-r--r-- | .github/doxygen-gh-pages.yml | 33 | ||||
| -rw-r--r-- | docs/Doxyfile | 110 |
2 files changed, 143 insertions, 0 deletions
diff --git a/.github/doxygen-gh-pages.yml b/.github/doxygen-gh-pages.yml new file mode 100644 index 0000000..7323d7e --- /dev/null +++ b/.github/doxygen-gh-pages.yml @@ -0,0 +1,33 @@ +name: Deploy Doxygen Documentation + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Doxygen + run: | + sudo apt-get update + sudo apt-get install -y doxygen graphviz + + - name: Generate Doxygen Documentation + run: doxygen Doxyfile + + - name: Deploy to GitHub Pages + if: github.ref == 'refs/heads/main' # Only deploy on main branch + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/html + enable_jekyll: false + full_commit_message: Deploy Doxygen documentation
\ No newline at end of file diff --git a/docs/Doxyfile b/docs/Doxyfile new file mode 100644 index 0000000..1315f15 --- /dev/null +++ b/docs/Doxyfile @@ -0,0 +1,110 @@ +# Doxyfile for FBGL (Framebuffer Graphics Library) + +# Project information +PROJECT_NAME = "FBGL" +PROJECT_NUMBER = "0.1.0" +PROJECT_BRIEF = "Framebuffer Graphics Library" +PROJECT_LOGO = +OUTPUT_DIRECTORY = docs +CREATE_SUBDIRS = NO +ALLOW_UNICODE_NAMES = NO +OUTPUT_LANGUAGE = English + +# Build settings +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = YES +EXTRACT_ANON_NSPACES = NO + +# Input files +INPUT = . +FILE_PATTERNS = *.h +RECURSIVE = YES +EXCLUDE = +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = + +# Source browsing +SOURCE_BROWSER = YES +INLINE_SOURCES = YES +STRIP_CODE_COMMENTS = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES + +# HTML output +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = YES +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = NO +GENERATE_TREEVIEW = YES +ENUM_VALUES_PER_LINE = 4 +TREEVIEW_WIDTH = 250 + +# Other output formats +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +GENERATE_XML = NO +GENERATE_DOCBOOK = NO +GENERATE_AUTOGEN_DEF = NO +GENERATE_PERLMOD = NO + +# Preprocessing +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = FBGL_IMPLEMENTATION \ + FBGL_USE_FREETYPE \ + FBGL_HIDE_CURSOR +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = NO + +# Dot tool settings +HAVE_DOT = YES +DOT_NUM_THREADS = 0 +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +DOT_UML_DETAILS = NO +DOT_WRAP_THRESHOLD = 17 +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES + +# General settings +OPTIMIZE_OUTPUT_FOR_C = YES +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +GROUP_NESTED_COMPOUNDS = NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = NO +TYPEDEF_HIDES_STRUCT = NO +LOOKUP_CACHE_SIZE = 0
\ No newline at end of file |
