You are here: Recent News » NaturalDocsSEPY

 

NaturalDocsSEPY

NaturalDocsSEPY is a windows batch file written by Mark Walters that you can run from SEPY that will autocreate NaturalDocs folders and documentation in the same directory as the ActionScript file you are working on.

Download it here (NaturalDocsSEPY.zip)

Usage

  1. Put your NaturalDocs-1.33 directory in the C:\Program Files\SEPYActionScript Editor\utils directory. (or edit the new batch file to match where your current NaturalDocs-1.33 directory lies).
  2. Download the batch file.
  3. Add the batch file into the NaturalDocs-1.33 directory.
  4. In SEPY, go to Tools–>Preferences–>Tools and add a New item.
  5. Command path should be the path to the NaturalDocsSEPY.bat file.
  6. Arguments:
    @dir HTML (or FramedHTML) otherParams
    • 1st argument must be @dir
    • 2nd argument must be the output format
    • 3rd-n arguments can be any other NaturalDocs argument (-s Small -t 2, etc)
  7. Hit apply.
  8. Run the new tool.
  9. Find the new NaturalDocs directories in the same directory as your ActionScript file.

Update for NaturalDocs versions greater than 1.33

Tested the batch file with version 1.34 and it works.

To use the batch file with the new version of NaturalDocs, edit the batch file in Notepad and change the 2nd to last line to go to the new directory of your NaturalDocs program:

"C:\ProgramFiles\SEPY ActionScript Editor\utils\NaturalDocs-1.34\NaturalDocs"

If you don’t want to edit the batch file with every new version of NaturalDocs, make the line go to a standard location like:

"C:\ProgramFiles\SEPY ActionScript Editor\utils\NaturalDocs\NaturalDocs"

...and replace the NaturalDoc files in that location with every new version.

Update for Hyphens in the Directory Name

Seems that you need to remove some of the quotes in the last line of the script after download, to get it working if there’s hyphens in the directory name:

C:\Perl\bin\perl.exe "C:\Program Files\SEPY ActionScript Editor\utils\NaturalDocs-1.34\NaturalDocs" -i "%directory%" -o %format% "%directory%\NaturalDocs\Documentation" -p "%directory%\NaturalDocs\Project" %NaturalDocsParams%

...becomes...

C:\Perl\bin\perl.exe "C:\Program Files\SEPY ActionScript Editor\utils\NaturalDocs-1.34\NaturalDocs" -i %directory% -o %format% %directory%\NaturalDocs\Documentation -p %directory%\NaturalDocs\Project %NaturalDocsParams%

Now works for hyphens - hope I haven’t broken anything else :)

See Also

Main Natural Docs page.

naturaldocssepy.txt · Last modified: 2006/06/16 04:22 by driverjase