On approximately 7/12/2009 7:49 PM, came the following characters from the keyboard of Kevin Marshall: > Glenn, > > Yes, you're right, the documentation for the module is contained > within the source code and is extracted during the build process. For > a module this large, it probably made sense in the beginning to use > this method to create the docs, but as the module has grown, I imagine > it has become more difficult to manage. Perhaps moving the > documentation into their own files is something for the developers to > look at for the next release. Most of the changes I made to the docs > involved replacing the TBD sections with the required information, as > well as supplying more information about input parameters and return > values for most of the functions.
Seems to me that the larger a project gets, the better it is for the documents to be in the source... because if something is changing in the code, the change to the documentation is right there too. However, you seem to hold the opinion that having separate documentation files would be better in some unstated way? I haven't had a chance to read your updated docs, but the kinds of changes you describe sound extremely helpful. While I hold a commit bit to the repository, and have made some minor bug fixes in the past, the primary developer in recent years has been Rob May... but I think he got busy with other things, and hasn't been very active here lately, which is sad for this module, as he was doing some excellent things to it. So at the present time, I'm not sure 1) if there are any active developers 2) if there are any that would agree that moving the documentation to separate files would be a good thing 3) who would apply your documentation patches to the repository, even if you submitted them that way, rather than creating your own web site I don't remember if Reini has a commit bit or not, but I don't think he's ever built a release. There have been significant changes to sourceforge in the intervening period, as well, so it would take some learning curve for me (and probably for Reini, although maybe he's up on the sourceforge changes from other projects) to attempt to build a release, methinks. Or maybe Rob will poke his head in here, and say that he could find some time to commit some doc changes and build a new release... ------------------------------------------------------------------------------ Enter the BlackBerry Developer Challenge This is your chance to win up to $100,000 in prizes! For a limited time, vendors submitting new applications to BlackBerry App World(TM) will have the opportunity to enter the BlackBerry Developer Challenge. See full prize details at: http://p.sf.net/sfu/Challenge _______________________________________________ Perl-Win32-GUI-Users mailing list Perl-Win32-GUI-Users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/perl-win32-gui-users http://perl-win32-gui.sourceforge.net/
