Natural Docs Wizard

A small wizard application to create and edit Natural Docs batch files
Download

Natural Docs Wizard Ranking & Summary

Advertisement

  • Rating:
  • License:
  • Freeware
  • Publisher Name:
  • Todd Davis
  • Publisher web site:
  • http://www.seaburydesign.com/Home/tabid/36/language/en-US/Default.aspx
  • Operating Systems:
  • Windows All
  • File Size:
  • 17 KB

Natural Docs Wizard Tags


Natural Docs Wizard Description

The Natural Docs Wizard was developed to be a small wizard application to create and edit Natural Docs batch files.I just recently began programming in C++ (VB.NET is my is how I earn my wages) and have taken a stab at writing some small classes and programs. Being one who likes to share, I think it's a good idea to include some documentation with the programs that you share online, so people have some idea of what is going on in your code without having to pick it apart piece by piece.I asked some folks in the programming community what the best documentation software was for C++, and of course, I got a lot of answers. But the two most popular packages were DoxyGen and Natural Docs. Both are excellent products, but I happened to like the style of Natural Doc's comment syntax, and so I chose to try that out first.Natural Docs makes commenting your code very easy and natural. But in order to run Natural Docs, you need to first create a batch file (unless you're a sucker for punishment) to run the program with all of its required paths and options. DoxyGen requires the same thing, but has a nice little wizard to do the dirty work for you. I know the author of Natural Docs is hard at work expanding the program's features, and probably hasn't had time to get around to doing this kind of stuff yet, so I just rolled my own.Natural Docs Wizard is a simple GUI to create, edit, and save Natural Docs batch files. It includes all the possible options as of Natural Docs v1.22, including the ability to have multiple input and output files and formats. It can read batch files written in either shorthand or longhand option notation (i.e., -i or --input or --source). You can specify your own *.css files as well - anything in the /Styles folder will be read by the program and offered up for your use. Tool tips have been used to death in the program in order to give you an idea of what options do what, in case you forgot. Overall, the program is very self explanatory, and will always show you a "live" copy of the batch file as you work. You can choose to run the batch file right from the wizard.


Natural Docs Wizard Related Software