topic Re: Source Code Documentation in Discussions

Source Code Documentation

David_Burnham — Fri, 26 Jan 2018 10:34:55 GMT

I currently use NaturalDocs to automatically generate HTML-based documentation of the JSL code that I write. I works fairly well with simple comment-markup within the code:

I'm currently setting up a new dev environment and it's an opportunity to review the tools within my workflow. I just wondered if anyone has any other thoughts on documentation-generation tools for JSL?

Re: Source Code Documentation

ih — Fri, 26 Jan 2018 14:22:34 GMT

I started down this path with DOxygen (I use a spin off, roxygen2, extensively in R) but didn't get far enough to deploy anything with JSL. NaturalDocs seems like a good fit.

Re: Source Code Documentation

pmroz — Fri, 26 Jan 2018 15:24:12 GMT

NaturalDocs looks very interesting. Thanks for making us aware of it!

Slight branch to this discussion: here are some open source utilities that I find indispensable for program development:

TortoiseSVN: Helps programmers manage different versions of the source code for their programs (source code control system). Apache™ Subversion (SVN)® client, implemented as a Windows shell extension.

Notepad++: Windows Notepad on steroids. Syntax colorization for most languages.

Kdiff3: Windows-based diff program. Great for finding and merging differences between two or three files or directories.

Re: Source Code Documentation

uday_guntupalli — Fri, 26 Jan 2018 16:29:40 GMT

@David_Burnham,
I tried to take cue and install Natural Docs. After setting it up the way detailed here (http://www.naturaldocs.org/getting_started/getting_set_up/#starting_a_new_project) , when I try to run configure to generate documentation , I get the follow ing

However, as instructed , I did provide the input folder and output folder - Any thoughts on what I did wrong ?

Re: Source Code Documentation

David_Burnham — Fri, 26 Jan 2018 18:30:43 GMT

@uday_guntupalli I'm going ahead and installing it on a new computer. I'm happy to document and share the procedure once it's complete it(I had to extend the configuration to handle the JSL language).

Re: Source Code Documentation

David_Burnham — Fri, 26 Jan 2018 20:24:50 GMT

I've just installed on a new PC - attached is a description of the process