Reply to topic  [ 2 posts ] 
Possible to output all /* DOCUMENT ... */ tags? 
Author Message
Yorick Padawan

Joined: Tue Jun 07, 2011 1:46 pm
Posts: 32
Location: UNH
Post Possible to output all /* DOCUMENT ... */ tags?
Hi,

Is it possible to output all documentation of functions within Yorick as well as included functions that make use of the /* DOCUMENT */ tags? It would be very useful to me because we are working with Yorick legacy code and if this function already existed it would save me from writing some kind of script to do this.

R


Mon Jul 30, 2012 4:56 am
Profile
Yorick Master

Joined: Mon Nov 22, 2004 9:43 am
Posts: 354
Location: Livermore, CA, USA
Post Re: Possible to output all /* DOCUMENT ... */ tags?
If you just type help at the yorick prompt, it tells you exactly where to find all the DOCUMENT comments; they are in the Y_SITE/doc directory in files that end with ".doc". If you type help,mkdoc you will get a description of the function used to extract all these DOCUMENT comments, which you can run on your own .i files. (The mkdoc function is mentioned if you type library at the yorick prompt, along with most of the other standard interpreted library in Y_SITE/i.)


Tue Aug 07, 2012 2:40 pm
Profile
Display posts from previous:  Sort by  
Reply to topic   [ 2 posts ] 

Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
cron
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group.
Designed by STSoftware for PTF.