Hi I am new to the list but have been using Harbour for some years now and have noticed recent discussions about documentation, how to develop it, store it etc and thought I might add my comments for what they are worth. I would not be fully across all discussions that would have taken place on this subject, so please bear that in mind when reading and considering the following.
I noticed some people suggested using tools (like doxygen) that essentially take marked up comments in source code and produce documentation from that. I think that this is not ideal since 1. It is essentially a single language solution 2. coders aren't necessarily the best documentors I noticed comment also that the proposed tools weren't written in Harbour. Whilst that shouldn't absolutely preclude their use, I believe that the more we use tools that are written in Harbour 1. More of our community can understand and work with them and if necessary or desirable modify them 2. They should be available either as is, or with some modification, to any Harbour user regardless of their platform(s) of choice. Personally I would like to see documentation in dbf / dbt format, with the "actual documentation" in xml format in a memo field, and the other fields basically define what is being documented. We might have something like the following: Key Language ( eg English, Spanish etc) Subject (eg Harbour ) Manual (eg Language Reference, Compiler Reference, Contribution etc ) Chapter (eg Classes, Commands, Functions, Statements, Directives etc ) Section (eg Array Functions, Time Date Functions ) Subject (eg AAdd(), AClone() etc ) Version (eg Version 2) Status (eg Released, Being Written ) Content (in xml?) and probably some working fields Page Reference Presumably then any Harbour user could download those bits of documentation they want / have been updated / all of it and we could have Harbour code to output it in whatever formats are required and iclude in specialised editors, IDEs etc. Just my thoughts Regards Doug
_______________________________________________ Harbour mailing list (attachment size limit: 40KB) [email protected] http://lists.harbour-project.org/mailman/listinfo/harbour
