PointCloudLibrary / PointCloudLibrary/pcl

[doc] Add dependency graphs to documentation

Open
#4,047 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind: request kind: todo module: docs
Dominant language
C++
Stars
11.1k
Forks
4.7k
Avg merge
4d 10h
Merged PRs (30d)
6

Description

Is your feature request related to a problem? Please describe.

I'm always frustrated when I can't see updated dependency graphs in the documentation, showing the actual dependencies between modules as parsed by Doxygen. (yeah right)

Context

Provide an updated view on dependencies not requiring delving into CMakeLists.txts or using old images available online.

Expected behavior

The documentation available at https://pointcloudlibrary.github.io/documentation/modules.html could include a generated graph from the code.

Current Behavior

There is no graph available in the modules inside that webpage.

Describe the solution you'd like

There is a graph available for each module inside that webpage. Generated via Doxygen to make it "easy" as it should be available thanks to the GROUP_GRAPHS configuration option which is currently enabled as well in our doxyfile.

Describe alternatives you've considered

It's a nice-to-have, not anything mandatory, so no other alternatives yet.

Additional context

This issue template is really in depth.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository's doxyfile and documentation generation setup, then inspect the modules documentation at pointcloudlibrary.github.io/documentation/modules.html. Check how GROUP_GRAPHS is configured and how module pages are generated. Done means the published documentation includes a generated dependency graph for each module.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.