instead organize in plain .txt  i suggest  organized in dbfMore easy to
organize,order,publish
is a clear demo of harbour capability

2009/7/8 Pritpal Bedi <[email protected]>

>
> Hello Vailton
>
>
> Vailton Renato wrote:
> >
> > There are a total of approximately 1600 functions. By my count if a
> > person is available to document at least 5 functions per day, he will
> > complete the service in less than 1 year.
> >
> > I was studying the issue of documentation and I thought of something
> > that I believe can help us. But it will take a few days to build a
> > structure that will create the documentation in those languages are
> > required and results can be published in HTML or PDF.
> >
> >
> > Anyway, I'm planning on testing it with our product here in Brazil and
> > then submit to you the results of my tests.
> >
> > If all goes well, I think we could use this solution to produce
> > documentation for our project.
> >
> > I can even help to produce the documentation in English, and obviously
> > I will need the help of everyone about questions and clarify some
> > details regarding functions, procedures and others.
> >
> > What the group thinks about this idea?
> >
>
> I was also thinking along this line and I already have some
> basic code to parse source tree ( provided by Andy Wos of xMate ).
> My intention was :
>
> 1) Parse the source tree, gather function arguments and return values
> 2) Organize them in plain .txt files with skeleton something like:
>        FUNCTION: funcname()
>        PARAMETERS: param1, param2, ... paramN
>        RETURNS: xRet
>        DESCRIPTION:
>        EXAMPLE:
>        SOURCE:
> 3) Place these skeletons in somewhere harbour/doc/skeletons/dirToRepsType
> 4) Request all group member to pick one,two or any number of functions
> he/whe is willing and fill in the blanjs
> 5) Place the filled in text in harbour/doc/worked/dirToRepsType
> 6) Request for volunteers to moderate those changes and make necessary
> changes
> 7) Build a compiled help from those filled-in skeltons.
>
> And may be more ideas which could flash at  given moment.
>
> I was planning to do so after finishing HBXBP. It is nice to see that you
> have
> the same plans in mind. Please go ahead.
>
> Regards
> Pritpal Bedi
>
>
> --
> View this message in context:
> http://www.nabble.com/About-hbextern...-tp24391919p24393130.html
> Sent from the Harbour - Dev mailing list archive at Nabble.com.
>
> _______________________________________________
> Harbour mailing list
> [email protected]
> http://lists.harbour-project.org/mailman/listinfo/harbour
>



-- 
Massimo Belgrano
_______________________________________________
Harbour mailing list
[email protected]
http://lists.harbour-project.org/mailman/listinfo/harbour

Reply via email to