While peeking around the xml documentation for rexxref I stumbled over comments
that read like
rexxref/en-US/alarmnotificationclassmethods.xml:<!--
$GENERATED-20151014-START
rexxrefClassRow(AlarmNotification) -->
rexxref/en-US/alarmnotificationclassmethods.xml:<!-- $GENERATED-20151014-END
rexxrefClassRow(AlarmNotification) -->
Here a list of xml files that seem to contain such generated text ("GENERATED"
in uppercase):
rexxpg/en-US/provide.xml
rexxref/en-US/alarmnotificationclassmethods.xml
rexxref/en-US/collclasses.xml
rexxref/en-US/collectionclassmethods.xml
rexxref/en-US/comparableclassmethods.xml
rexxref/en-US/comparatorclassmethods.xml
rexxref/en-US/directoryclassmethods.xml
rexxref/en-US/eventsem-rgf.xml
rexxref/en-US/fundclasses.xml
rexxref/en-US/inputoutputstreamclassmethods.xml
rexxref/en-US/inputstreamclassmethods.xml
rexxref/en-US/mapcollectionclassmethods.xml
rexxref/en-US/messagenotificationclassmethods.xml
rexxref/en-US/mutexsem-rgf.xml
rexxref/en-US/objectclassmethods.xml
rexxref/en-US/orderableclassmethods.xml
rexxref/en-US/orderedcollectionclassmethods.xml
rexxref/en-US/outputstreamclassmethods.xml
rexxref/en-US/provide.xml
rexxref/en-US/queueclassmethods.xml
rexxref/en-US/setcollectionclassmethods.xml
rexxref/en-US/streamclasses.xml
rexxref/en-US/supplierclassmethods.xml
rexxref/en-US/utilityclasses.xml
rxsock/en-US/mimeclass.xml
rxsock/en-US/smtp.xml
rxsock/en-US/socketclass.xml
rxsock/en-US/streamsocket.xml
It seems that some script (which one, where to find) runs that injects entries
in those files?
So the question would be what the "howtos" would be in order to create new
documentation and
incorporate it into the current documenation properly?
What steps does one need to take to add text to "rexxref.xml", if I were to add
documentation of the
new ooRexx classes EventSemaphore and MutexSemaphore (cf. eg.
<https://sourceforge.net/p/oorexx/patches/210/>)?
What are the general steps to follow to be sure that nothing gets overlooked?
----rony
_______________________________________________
Oorexx-devel mailing list
Oorexx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/oorexx-devel
