search

mgalloy / idldoc

Documenting IDL code
Other
21 stars 13 forks source link

Create a "man page" front end for IDLdoc #11

Closed mgalloy closed 11 years ago

mgalloy commented 11 years ago

Create a "man page" front end for IDLdoc that, given an individual routine name, would output the documentation for that routine.

The syntax for it would be something like:

  IDL> man, 'idldoc'
  /Users/mgalloy/projects/idldoc/trunk/idldoc/src/idldoc.pro

  idldoc, root=string [, output=string] [, /quiet] [, /silent] [, n_warnings=long] 
    [, log_file=string] [, /assistant] [, /embed] [, overview=string] [, footer=string] 
    [, title=string] [, subtitle=string] [, /nonavbar] [, /nosource] [, /user] [, /statistics] 
    [, format_style=string] [, markup_style=string] [, comment_style=string] 
    [, /preformat] [, /browse_routines] [, template_prefix=string] 
    [, template_location=string] [, charset=string] [, error=long] [, /help] [, /version]

  Generate documentation for IDL code. This is a wrapper routine for the doc_system 
  class; this routine only handles errors, saving/restoring !path, and creating the 
  doc_system object.

  etc...
mgalloy commented 11 years ago

The MAN routine in cmdline_tools handles the header, but not the documentation.

mgalloy commented 11 years ago

Changed the MAN routine in cmdline_tools to show the documentation header verbatim (no IDLdoc parsing required). This works for any type of documentation that uses the ;+/;- notation immediately before the routine.