I've decided to work my way from the inside out: start with class documentation and move outward toward the general.
I'm looking for feedback on document structures that you've found most useful. Specifically, structures documenting classes and their methods.
I'm thinking this:
+Class Name
- Description
+ Instantiation
+ var = wxWhatever(arguments, using standard descriptive names) - list of arguments, indicating type and purpose
+ Methods
+ .Method1(arguments)
- description of returned value
- description of arguments
- description of side-effects
+ .Method2(arguments)
etc
+ Properties/Constants
+ .Methodx()
- type and purpose of returned value
- Cross Reference
- Code Example
+ Illustrations
- Windows
- ?
Q: is it worth arbitrarily dividing methods between those that cause a change in the instantiated object, and those that return a value from it without changing it?
Q: is there an on-line document, in any programming language, that you've found is extremely well-structured?
Q: got a suggestion?
So far, I've had feedback from two people. This isn't the sort of support I'd expected. Surely some of you are professional-level programmers with experience in other languages, and a decent library of reference manuals, some of which you think are great!
Come on. 'fess up. Share.
Thx,
david
(plodding toward getting interested in doing this)
PS: OTOH, I stumbled across the beginnings of a wxPython tutorial I started writing a couple years ago. If it weren't for my abandoning the project (a clone of Quicken; became rather redundant when I bought Quicken...) it'd have been a damn fine work. If I could come up with another project of a few months duration, worth my being interested in, I could begin again...
...alternatively, if anyone's doing something useful and open-source, I could be picking your brains. You'd need to have a pretty clear idea of what you did, when you did it and why...
···
_______________________________________________
wxPython-users maillist - wxPython-users@starship.python.net
http://starship.python.net/mailman/listinfo/wxpython-users