Menu
▾
▴
Re: [Oorexx-devel] A good use for Rony's class reflection program.
|
From: Rick M. <obj...@gm...> - 2007-10-04 13:16:07
|
That looks nice. I particularly like the eye-catcher comments. It makes it a lot easier to navigate through the different methods/classes. Rick On 10/4/07, Rony G. Flatscher <Ron...@wu...> wrote: > > > Rick McGuire wrote: > > No rush on this, I was just looking for future efforts. Anyway, here's > sort of the minimal bit from the DateTime class, which is a good example as > it also inherits from Comparable: > > Was able to get enough time in a piece to create a generator using the > reflection mechanism and ran the program for the classes "ArgUtil" (which > seems to not have it made into the docs yet), "DateTime" and "TimeSpan". To > see the effects of inherited methods there is also a gnerated file available > for the "Bag" class. > > A few remarks: > > - the text has indentations and comments to ease navigating among and > finding of the different sections, > - the methods are sorted ascendingly using the caselessComparator, > - first the class methods, if any, are listed, followed by the instance > methods, > - for methods that have the flags "unguarded", "private" and/or > "protected" set, a canned text is generated as well, > - the string "<todo>TODO: ... </todo>" is inserted to draw the attention > to the areas where individual documentation is needed (text, rail diagrams, > etc.) or a problem may exist (e.g. operator method characters), > > The results are at: <http://wi.wu-wien.ac.at/rgf/rexx/misc/refCard/tmp/><http://wi.wu-wien.ac.at/rgf/rexx/misc/refCard/tmp/> > . > > If there are errors, needs for changes (e.g. spaces matter in some > elements), then please let me know. > > ---rony > > > > <section id="clsDateTime"><title>The DateTime Class</title> > <indexterm><primary>DateTime class</primary></indexterm> > <indexterm><primary>class</primary> > <secondary>DateTime class</secondary></indexterm> > > <para>A DateTime object represents a point in between 1 January 0001 at > 00: 00.000000 > and 31 December 9999 at 23:59:59.999999. A DateTime object has methods to > allow > formatting a date or time in various formats, as well as allowing > arithmetic operations between > dates. > </para> > <figure><title>The DateTime class and methods</title> > <mediaobject> > <imageobject> > <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> > <imagedata fileref=" ooRexxAlarmClass.png" align="left"> > </imageobject> > </mediaobject> > </figure> > <note><title>Note</title> > <para>The DateTime class also has available class methods that its > metaclass, the <link linkend="clsClass">Class class</link>, > defines.</para></note> > > <section><title>Inherited Methods</title> > > &objclsmthods; > > <para>Methods inherited from the > <link linkend="clsComparable">Comparable class</link>.</para> > <itemizedlist> > <listitem><para><link > linkend="mthComparableCompareTo">compareTo</link></para></listitem> > </itemizedlist> > </section> > > > <section id="mthDateIsLeapyear"<title>isLeapyear</title> > <indexterm><primary>isLeapyear method</primary> > <secondary>of DateTime class</secondary></indexterm> > <indexterm><primary>method</primary> > <secondary>isLeapyear method</secondary> > <tertiary>of DateTime class</tertiary></indexterm> > <programlisting> > <![CDATA[ > >>-isLeapyear--------------------------------------------->< > ]]> > </programlisting> > > <para>Returns true ("1") if the current year is leap year. Returns false > ("0") if the current year is not a leap year. > </para> > </section> > > </section> > > > Rick > > > On 9/29/07, Rony G. Flatscher < Ron...@wu...> wrote: > > > > Rick, > > > As I'm sitting here writing the endless method documentation for > > > DateTime and TimeSpan, it occurred to me that a lot of the boilerplate > > > of the method documentation could be generated by your program that > > > generates the ref card. Just having all of the section, index entry, > > > etc. tags generated for a class with a skeleton railroad track diagram > > > and empty descriptive text would serious speed up the process of > > > writing documentation for new classes. > > Indeed. Also, in these situations being able to retrieve the correct > > casing of the method names is very helpful (and in the future, perhaps > > for class-inspectors). > > > > If you let me know the boilerplate for each method, I will create an > > according program. > > > > However, I would only be able to tackle that tomorrow evening due to > > family business duties which keep me off some of the things I really > > would like to do (e.g. to look over the ArgUtil, DateTime, TimeSpan > > classes, getting an overview of all the things that are new and reflect > > about them once more, but also to finalize the testUnit-web pages from > > which interested persons would easily pick the ones that he/she would be > > tackling, which also get automatically created, using the reflective > > stuff); also begin of semester, i.e. lecturing and meetings is ante > > portas... > > > > So if you can wait another day and a half, and let me know the > > boilerplate text, then you should have it by tomorrow evening Austrian > > time (GMT +2). > > > > ---rony > > > > P.S.: Also, today I finally made the switch to my new laptop (after many > > months, and made sure that I can compile ooRexx from svn ;) ), but > > expect little problems from time to time, as I had too much installed on > > > > the old one, which I will probably start to miss, once the old laptop is > > physically out of reach... > > > > > > > > ------------------------------------------------------------------------- > > This SF.net email is sponsored by: Microsoft > > Defy all challenges. Microsoft(R) Visual Studio 2005. > > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > > _______________________________________________ > > Oorexx-devel mailing list > > Oor...@li... > > https://lists.sourceforge.net/lists/listinfo/oorexx-devel > > > > ------------------------------ > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Microsoft > Defy all challenges. Microsoft(R) Visual Studio 2005. > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > > ------------------------------ > > _______________________________________________ > Oorexx-devel mailing list > Oor...@li...https://lists.sourceforge.net/lists/listinfo/oorexx-devel > > > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Splunk Inc. > Still grepping through log files to find problems? Stop. > Now Search log events and configuration files using AJAX and a browser. > Download your FREE copy of Splunk now >> http://get.splunk.com/ > _______________________________________________ > Oorexx-devel mailing list > Oor...@li... > https://lists.sourceforge.net/lists/listinfo/oorexx-devel > > |