Opened 3 months ago

Closed 3 months ago

Last modified 2 months ago

#32366 closed task (implemented)

doxygen: use directory hierarchy, and start documenting directories

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: 1
Parent ID: #29214 Points: 1
Reviewer: dgoulet Sponsor:

Description

Initial work here in branch doxygen_org, PR at https://github.com/torproject/tor/pull/1492 .

Child Tickets

Change History (10)

comment:1 Changed 3 months ago by nickm

Status: assignedneeds_review

Once the initial work is in, I'm going to start moving in directory-by-directory documentation for the rest of the code.

comment:2 Changed 3 months ago by dgoulet

Status: needs_reviewmerge_ready

looks great!

comment:3 Changed 3 months ago by nickm

Status: merge_readyaccepted

Merged! Now to copy over a bunch more documentation.

comment:4 Changed 3 months ago by nickm

Status: acceptedneeds_review

The next section of work here is in a branch called doxygen_libs, with PR at https://github.com/torproject/tor/pull/1493

It begins moving documentation from doc/HACKING/design into our source code reference, and covers all of src/lib. We should also write some topic-specific items; they will need their own pages.

comment:5 Changed 3 months ago by nickm

I've extended the branch and the PR to cover each directory.

comment:6 Changed 3 months ago by dgoulet

Reviewer: dgoulet
Status: needs_reviewneeds_revision

Minor tweaks I pointed out in the PR. After those, feel free to merge.

comment:7 Changed 3 months ago by nickm

Fixed and merged!

comment:8 Changed 3 months ago by nickm

Resolution: implemented
Status: needs_revisionclosed

comment:9 Changed 3 months ago by nickm

Actual Points: 1

comment:10 Changed 2 months ago by nickm

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