#32510 closed defect (implemented)

Rename .dox files to end with .md, and remove their /** magic **/

Reported by: nickm Owned by: nickm
Priority: Medium Milestone: Tor: 0.4.3.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: network-team-roadmap-november, s31-docs
Cc: nickm, catalyst Actual Points: 0
Parent ID: #29214 Points:
Reviewer: Sponsor: Sponsor31-can


I thought that we had to have documentation-only doxygen files wrapped in / and /. But we don't: we can just tell doxygen that those files are markdown, and it will do the right thing.

We should make this change so that other tools (like github) that have special handling for markdown can pretty-print our markdown files, and so that we can eventually incorporate some/all of doc/HACKING into our doxygen.

Child Tickets

Change History (3)

comment:1 Changed 11 months ago by nickm

Status: assignedneeds_review

See branch dox_to_md with PR at https://github.com/torproject/tor/pull/1542

comment:2 Changed 11 months ago by ahf

Status: needs_reviewmerge_ready

Looks good.

comment:3 Changed 11 months ago by nickm

Resolution: implemented
Status: merge_readyclosed


Note: See TracTickets for help on using tickets.