| Re: IDLdoc 3.0 released [message #58136] |
Tue, 22 January 2008 09:59  |
Brian Larsen
Messages: 270
Registered: June 2006
|
Senior Member |
|
|
> Remove the spaces between ...
>
> ;-
>
> Function...
Yep, I knew it was something simple!!!
Thanks
Brian
------------------------------------------------------------ -------------
Brian Larsen
Boston University
Center for Space Physics
|
|
|
|
|
|
|
|
|
|
| Re: IDLdoc 3.0 released [message #58141 is a reply to message #58140] |
Tue, 22 January 2008 09:32  |
KRDean
Messages: 69
Registered: July 2006
|
Member |
|
|
On Jan 22, 6:48 am, Vince Hradil <hrad...@yahoo.com> wrote:
> On Jan 21, 11:47 pm, "mgal...@gmail.com" <mgal...@gmail.com> wrote:
>
>
>
>
>
>> IDLdoc 3.0 is ready! Highlights of this release:
>
>> * IDLdoc 3.0 was rewritten from scratch to allow it to be released
>> under an open source license. Source code is available from the
>> project website.
>
>> * There are multiple formats for entering comments: the normal
>> IDLdoc style, the traditional IDL comment header, and new style based
>> on restructured text.
>
>> * Ability to do some simple formatting of comments without resorted
>> to putting ugly HTML into your comments.
>
>> For more information about this release, see the project website
>> download page:
>
>> http://idldoc.idldev.com/wiki/Downloads
>
>> Mike
>> --www.michaelgalloy.com
>> Tech-X Corporation
>> Software Developer II
>
> Mike,
> Maybe I'm a little dense, but I can't figure out how your program
> works. Perhaps your bullet point "read user information about IDLdoc"
> might help, but there is no link. What are the installation
> instructions, requirements, and usage?
>
> Thanks,
> Vince- Hide quoted text -
>
> - Show quoted text -
This may help. I created some IDL code that I use and modify whenever
I start a new project.
I'll include a sample overview and footer htm file, as well as the IDL
code that calls IDLdoc.
Kelly Dean
Fort Collins, CO
====================== Sample Overview.htm
===========================
<H2>Generate HTML Documetation</H2>
<P>The Generate HTML Documentation is designed to create HTML reports
from comments
found in the IDL code.
<P>This application was developed with ITT Visual Information
Solutions'
(ITTVIS) Data Analysis and Visualization Software - Interactive Data
Language (IDL).
<P>Kelly Dean - January 2008
:Dirs:
./
Root directory with main IDL routines
====================== Sample Footer.htm ============================
<!-- Project Footer -->
<CENTER>
<FONT STYLE="font-family: Arial; font-size: 8pt">
IDL Library.<BR>
Contact Information: <BR>
Kelly Dean<BR>
Fort Collins, Colorado<BR>
</FONT>
</CENTER>
======================= IDL Code ================================
;+
;
; :file_comments:
; <P>This routine is designed to use IDLdoc to create HTML
; documentation from IDL code. IDLdoc is a tool for
; generating documentation into HTML format from comments
; found in the source code.
;
; :keywords:
; root : in, type=string
; Directory path to IDL source files.
;
; output : in, type=string
; Directory path and name to HTML output.
;
; title : in, type=string
; Main title for HTML document.
;
; subtitle : in, type=string
; Subtitle for HTML document.
;
; overview : in, type=string
; Directory path and name for overview HTML file.
;
; footer : in, type=string
; Directory path and name for footer HTML file.
;
; statistics : in, type=string
; Calculate McCabe statistics for each routine
;
; :uses:
; IDLdoc : Document generator fould at idldoc.idldev.com
;
; :author:
; Kelly Dean
;
; :categories:
; Documentation
;
; :history:
; Created January 2008
;
;----------------------------------------------------------- -----------
PRO Gen_HTM_Doc3, root=root, $
output=output, $
title=title, $
subtitle=subtitle, $
overview=overview, $
footer=footer, $
statistics=statistics
; Initialize some variables
dirPath = 'C:\Test'
proj = 'GenHTML'
ver = '.0.0.1'
projver = proj + ver
; Location of IDLdoc save file
GalloySAV = dirPath + '\ContribIDL\Galloy\IDLdoc\idldoc.sav'
; Check keyword -
IF ( N_ELEMENTS( title ) EQ 0 ) THEN BEGIN
title = proj
ENDIF
; Check keyword - For subtitle
IF ( N_ELEMENTS( subtitle ) EQ 0 ) THEN BEGIN
subtitle = 'Generate HTML Documetation'
ENDIF
; Check keyword - IDL source
IF ( N_ELEMENTS( root ) EQ 0 ) THEN BEGIN
root = dirPath + '\Projects\' + projver + '\src'
ENDIF
; Check keyword - Output HTML directory
IF ( N_ELEMENTS( output ) EQ 0 ) THEN BEGIN
output = dirPath + '\Projects\' + projver + '\doc\html'
ENDIF
; Check keyword - Directory path and name of overview HTML code
IF ( N_ELEMENTS( overview ) EQ 0 ) THEN BEGIN
overview = dirPath + '\Projects\' + projver + '\Data\Input
\ProjOverview.htm'
ENDIF
; Check keyword - Directory path and name of footer HTML code
IF ( N_ELEMENTS( footer ) EQ 0 ) THEN BEGIN
footer = dirPath + '\Projects\' + projver + '\Data\Input
\ProjFoot.htm'
ENDIF
; Check keyword - Turn on/off McCabe statistics
IF ( N_ELEMENTS( statistics ) EQ 0 ) THEN statistics = 0
; Start IDLdoc.
RESTORE, GalloySAV
IDLDOC, FORMAT_STYLE='rst', $ ; IDL Doc format style (Restructure
text format)
root=root, $ ; Directory path of IDL code
output=output, $ ; Output directory
title=title, $ ; Main title
subtitle=subtitle, $ ; Subtitle title
overview=overview, $ ; Directory path and name of
overview HTML code
footer=footer, $ ; Directory path and name of footer
HTML code
statistics=statistics ; Turn on/off McCabe statistics
END
|
|
|
|
|
|
|
|
| Re: IDLdoc 3.0 released [message #58146 is a reply to message #58145] |
Tue, 22 January 2008 08:01 |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On Jan 22, 6:48 am, Vince Hradil <hrad...@yahoo.com> wrote:
> Maybe I'm a little dense, but I can't figure out how your program
> works. Perhaps your bullet point "read user information about IDLdoc"
> might help, but there is no link. What are the installation
> instructions, requirements, and usage?
Try
idldoc, root=source_code_dir, output=doc_dir
where `source_code_dir` is a directory containing IDL .pro or .sav
files and `doc_dir` is where you want the output to go. To view the
output, start with doc_dir\index.html. To learn how to format your
comments so that IDLdoc understands them, see the "Help" tab on
navigation bar on the top of any page.
Mike
--
www.michaelgalloy.com
Tech-X Corporation
Software Developer II
|
|
|
|
| Re: IDLdoc 3.0 released [message #58150 is a reply to message #58146] |
Tue, 22 January 2008 05:48 |
Vince Hradil
Messages: 574
Registered: December 1999
|
Senior Member |
|
|
On Jan 21, 11:47 pm, "mgal...@gmail.com" <mgal...@gmail.com> wrote:
> IDLdoc 3.0 is ready! Highlights of this release:
>
> * IDLdoc 3.0 was rewritten from scratch to allow it to be released
> under an open source license. Source code is available from the
> project website.
>
> * There are multiple formats for entering comments: the normal
> IDLdoc style, the traditional IDL comment header, and new style based
> on restructured text.
>
> * Ability to do some simple formatting of comments without resorted
> to putting ugly HTML into your comments.
>
> For more information about this release, see the project website
> download page:
>
> http://idldoc.idldev.com/wiki/Downloads
>
> Mike
> --www.michaelgalloy.com
> Tech-X Corporation
> Software Developer II
Mike,
Maybe I'm a little dense, but I can't figure out how your program
works. Perhaps your bullet point "read user information about IDLdoc"
might help, but there is no link. What are the installation
instructions, requirements, and usage?
Thanks,
Vince
|
|
|
|
| Re: IDLdoc 3.0 released [message #58247 is a reply to message #58136] |
Wed, 23 January 2008 07:09 |
Brian Larsen
Messages: 270
Registered: June 2006
|
Senior Member |
|
|
Mike,
this really is cool and useful. I decided to go through my library
last night and see what could be done "out of the box" and it worked
great. I had to reformat my headers a bit but no problem. In fixing
up the codes that didn't have headers I realized just how important
this is as there were several codes that I spend a lot of time writing
that I couldn't remember how to use at all, which seems like wasted
time.
http://people.bu.edu/balarsen/IDLdoc/
Thanks for a great package!
Brian
------------------------------------------------------------ -------------
Brian Larsen
Boston University
Center for Space Physics
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
