> Perhaps there would be a way to extract information from comments, if
there is a standard format for the comments (like scriptdoc).

The joxygen addon can be used to generate docs from comments, see
code.jsoftware.com/wiki/Addons/docs/joxygen . This replaces scriptdoc and
is currently used for the stdlib docs, see
www.jsoftware.com/help/user/library.htm .

On Tue, Oct 31, 2017 at 1:55 PM, Henry Rich <henryhr...@gmail.com> wrote:

> What you are talking about is what I was looking for as a starting point.
> It would give a list of addons, and within each addon, a list of scripts.
>
> Then, for each script someone would need to extract the entry points and
> add a description of what the entry point does.  Maybe this could be
> automated a little bit, but there would be a lot of hand work in any case.
>
> With the list of scripts on the Wiki, though, there might be many
> volunteers to fill in the entry points.
>
> Here's an idea: start with just a three-column table: the list of Addons,
> a description taken from the Manifest, and an empty column of keywords.
> Put it on the Wiki, and give people a month to fill in the description and
> keywords (I would think the addon writers would do this, mostly).  After
> the month, create the list of scripts within each Addon, with the keywords
> attached.  After that, we have to hope for volunteers.
>
> Perhaps there would be a way to extract information from comments, if
> there is a standard format for the comments (like scriptdoc).
>
>
> Henry Rich
>
>
> On 10/31/2017 3:01 PM, Raul Miller wrote:
>
>> Well...
>>
>> Conceptually speaking, the list of packages are the unique path name part
>> of
>>
>>     require 'general/dirutils'
>>     (#~ +./@('manifest.ijs' E. ])@>) {."1 dirtree '~addons'
>>
>> And, conceptually, some (but not all) of the information that the wiki
>> needs can be obtained from those manifests.
>>
>> The way things are right now, a person would need to go through each
>> manifest, and spend maybe a minute or five reading through it and its
>> references to build up what would be useful on the wiki page. So,
>> maybe an afternoon to build a draft page? And, after that and some
>> feedback, we could maybe have an idea about what should be in future
>> manifests to make this process better?
>>
>> I am not quite volunteering, yet - I'm still shaping out an idea of
>> where we are trying to head...
>>
>> Thanks,
>>
>>
>
> ---
> This email has been checked for viruses by AVG.
> http://www.avg.com
>
> ----------------------------------------------------------------------
> For information about J forums see http://www.jsoftware.com/forums.htm
>
----------------------------------------------------------------------
For information about J forums see http://www.jsoftware.com/forums.htm

Reply via email to