[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

[tor-bugs] #32510 [Core Tor/Tor]: Rename .dox files to end with .md, and remove their /** magic **/

#32510: Rename .dox files to end with .md, and remove their /** magic **/
-------------------------+-------------------------------------------------
     Reporter:  nickm    |      Owner:  nickm
         Type:  defect   |     Status:  assigned
     Priority:  Medium   |  Milestone:  Tor: 0.4.3.x-final
    Component:  Core     |    Version:
  Tor/Tor                |   Keywords:  network-team-roadmap-november,
     Severity:  Normal   |  s31-docs
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.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/32510>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online

_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs