Stata The Stata listserver
[Date Prev][Date Next][Thread Prev][Thread Next][Date index][Thread index]

st: RE: automatic documentation for Stata ?


From   "Nick Cox" <n.j.cox@durham.ac.uk>
To   <statalist@hsphsun2.harvard.edu>
Subject   st: RE: automatic documentation for Stata ?
Date   Fri, 7 May 2004 13:52:23 +0100

I'm not familiar with Javadoc. 

I think it is highly possible. You would need 
to read in a series of files, select the 
relevant stuff, and write to a master file. 
In Stata, you _could_ read in do files 
as string variables, but a better approach 
would probably be based on -file-. 

However, it would be surprising if anyone had 
anticipated your needs by writing some Stata 
code to do precisely this. Also, fond though 
I am of Stata, if this were my problem I would 
use some scripting language (Awk, Perl, Python, 
etc., etc.) or programmable text 
editor to automate this task. 

Iben Fasterholdt
 
> Is it possible to automatically generate documentation for 
> Stata do-files in
> the same fashion as in for example javadoc?
> 
> Introduction to javadoc, see the link below:
> http://java.sun.com/j2se/javadoc/
> 
> We would like to be able to write something like the following:
> 
> /*
> * @author (our names)
> * @version (versioninformation)
> * @description (description and usage of the program)
> * @param (program parameters)
> */
> 
> program define ....
> syntax ......
> .
> .
> .
> end
> 
> We would like to have a script that can gather all this 
> information from
> different do-files, to one documentation-file.  Does anyone 
> know of such a
> script / program?

*
*   For searches and help try:
*   http://www.stata.com/support/faqs/res/findit.html
*   http://www.stata.com/support/statalist/faq
*   http://www.ats.ucla.edu/stat/stata/



© Copyright 1996–2014 StataCorp LP   |   Terms of use   |   Privacy   |   Contact us   |   What's new   |   Site index