Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • Trac Trac
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Issues 246
    • Issues 246
    • List
    • Boards
    • Service Desk
    • Milestones
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
  • Wiki
    • Wiki
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • Legacy
  • TracTrac
  • Issues
  • #32386

Closed (moved)
(moved)
Open
Created Nov 05, 2019 by Nick Mathewson@nickm🍬

Doxygen: Make output more C-like

There are a couple of options we should set to make our doxygen output more C-like and less C++-like.

The TYPEDEF_HIDES_STRUCT option tells doxygen to handle typedef struct foo_t foo_t by making foo_t and struct foo_t synonymous. This lets doxygen find documentation that it would otherwise miss: otherwise, if it sees documentation for "int func(foo_t *)" and a prototype for "int func(struct foo_t)", it will think that the prototype is undocumented.

The HIDE_SCOPE_NAMES option tells doxygen to describe a member "member" of a struct "container" as "member", not "container::member".

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking