Bitcoin Forum
December 12, 2017, 06:44:44 PM *
News: Latest stable version of Bitcoin Core: 0.15.1  [Torrent].
 
   Home   Help Search Donate Login Register  
Pages: [1]
  Print  
Author Topic: Automatic code documentation for bitcoin core  (Read 815 times)
Cryptowatch.com
Full Member
***
Offline Offline

Activity: 182


View Profile WWW
October 25, 2014, 06:18:18 PM
 #1

Has it been considered using doxygen notation to be able to autogenerate documentation for bitcoin core source code? From using doxygen a lot, I find it very beneficial when browsing code.

For those not aware what doxygen does, when devs insert doxygen markup in the code, it is parsed by doxygen and creates very nice output which give a very good overview of the code. For example, you can click on the file tree,and then click on a file, and you immediately get a view of all the cointaining functions and their description.

Example output, it happend to be in japanese, but you get the point:



The transition could be done gradually, and there could be an automatic cronjob that updated the documentation and made it available on a website. Now, puting in doxygen markup in all the code at once would be quite the big task, but if devs wanted, it could be done step by step.

Personally I think it would be more user friendly than browsing the code at github only.

Thoughts?


Pages: [1]
  Print  
 
Jump to:  

Sponsored by , a Bitcoin-accepting VPN.
Powered by MySQL Powered by PHP Powered by SMF 1.1.19 | SMF © 2006-2009, Simple Machines Valid XHTML 1.0! Valid CSS!