Skip to content

Add Doxygen#216

Open
evgenykor wants to merge 1 commit into
inputlabs:mainfrom
evgenykor:kornev/add_doxygen
Open

Add Doxygen#216
evgenykor wants to merge 1 commit into
inputlabs:mainfrom
evgenykor:kornev/add_doxygen

Conversation

@evgenykor

@evgenykor evgenykor commented Aug 8, 2025

Copy link
Copy Markdown
Contributor

Generate up to date documentation for source code with Doxygen

includes make integration with

make docs

Final output has html with pretty call graphs structures like e.g.:

Screenshot from 2025-08-08 10-47-45

@marcos-diaz

marcos-diaz commented Aug 11, 2025

Copy link
Copy Markdown
Contributor
Screenshot 2025-08-11 at 17 50 06

I got it running (serving the HTML with npm serve 😅)

I'm not so familiar with big C/C++ project standards, but here some of my immediate (and naive) questions:

  • Under which section are the nice diagrams?
  • Does this really add much value for the developer compared to navigating the symbols with VSCode or IntelliJ?
  • Should be this intended as a purely optional thing? or be hosted somewhere like (docs.inputlabs.io)?

@evgenykor

Copy link
Copy Markdown
Contributor Author
  • Under which section are the nice diagrams?

Go to "Files" section then click on some of the files, there you could see functions associated to this file with call diagrams Diagram itself is also clickable - you may transfer to other function calls across all of that.

  • Does this really add much value for the developer compared to navigating the symbols with VSCode or IntelliJ?

It is documentation no navigating thing (i.e. it is not LSP server e.t.c.). One cool feature of having something like this - you always have up-to-date documentation because it is literally compiled from your source code at any given moment.

  • Should be this intended as a purely optional thing? or be hosted somewhere like (docs.inputlabs.io)?

Sure thing. It is totally up to you. I just wanted to share some of "best practices".

@evgenykor

Copy link
Copy Markdown
Contributor Author
  • I got it running (serving the HTML with npm serve 😅)

I usually just do python -m http.server 8888 with some port forwarding to remote server like ssh -L 8888:localhost:8888 ekornev@my_remote_server

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.

2 participants