Skip to content

YT-CPPGL-61: Prepare the GL module's documentation#106

Merged
SpectraL519 merged 93 commits intohgl-masterfrom
gl-docs-mkdocs
Apr 27, 2026
Merged

YT-CPPGL-61: Prepare the GL module's documentation#106
SpectraL519 merged 93 commits intohgl-masterfrom
gl-docs-mkdocs

Conversation

@SpectraL519
Copy link
Copy Markdown
Owner

  • Updated the project license
  • Added the Doxyfile and mkdocs.yml configuration files and a Makefile with documentation targets
  • Added documentation comments to the public API elements of the GL module
  • Prepared the tutorial pages and images for the GL module's documenation
  • Defined a utility script for generating documentation pages for the library's concepts
  • Renamed the return_type and non_void_return_type and related utility to use the result naming
  • Modified the PFS template implementation to accept arbitrary* search nodes
  • Renamed the enqueue vertex predicate types and arguments for algorithm templates to use the (search) node naming
  • Fixed the Dijkstra's algorithm implementation to properly utilize custom PFS search nodes and properly handle distance comparison within the min heap
  • Removed unused/redundant elements

Comment thread include/gl/algorithm.hpp
Comment thread include/gl/conversion.hpp
Comment thread include/hgl/algorithm/templates/bfs.hpp
Comment thread scripts/postprocess_doxyhtml.py Outdated
Comment thread pyproject.toml Outdated
Comment thread README.md Outdated
Copy link
Copy Markdown
Owner Author

@SpectraL519 SpectraL519 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@SpectraL519 SpectraL519 merged commit d2f4b51 into hgl-master Apr 27, 2026
5 checks passed
@SpectraL519 SpectraL519 deleted the gl-docs-mkdocs branch April 27, 2026 20:59
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

Successfully merging this pull request may close these issues.

1 participant