Opened 3 months ago

Closed 3 months ago

Last modified 3 months ago

#32386 closed defect (implemented)

Doxygen: Make output more C-like

Reported by: nickm Owned by: nickm
Priority: Medium Milestone: Tor: 0.4.3.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords:
Cc: Actual Points: 0
Parent ID: #29214 Points: 0
Reviewer: ahf Sponsor: Sponsor31-can

Description

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".

Child Tickets

Change History (5)

comment:1 Changed 3 months ago by nickm

Actual Points: 0
Status: assignedneeds_review

Branch is ticket32386 with PR at https://github.com/torproject/tor/pull/1503

comment:2 Changed 3 months ago by dgoulet

Reviewer: ahf

comment:3 Changed 3 months ago by ahf

Status: needs_reviewmerge_ready

Looks OK with me (assuming I understand the consequence of the chance correctly).

comment:4 Changed 3 months ago by nickm

Resolution: implemented
Status: merge_readyclosed

merged!

comment:5 Changed 3 months ago by nickm

Parent ID: #29214
Note: See TracTickets for help on using tickets.