php-gtk:gtkphd
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
php-gtk:gtkphd [2009/05/05 21:36] – Page moved from ideas:gtkphd to php-gtk:gtkphd lsmith | php-gtk:gtkphd [2011/02/26 23:33] – Added part.tpl to stage one frozenfire | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ==== PHP-GTK PhD migration | + | ==== Migration to Main Manual |
- | PHP-GTK's docs should | + | The PHP-GTK |
- | Would involve | + | === Progress === |
- | - migrating the current documentation to a docbook 5 format | + | |
- | - writing a PhD compatible theme to generate documentation | + | |
- | - writing a reflection based updater to keep docs up to date with code (parsing signals, methods, properties and updating the xml) | + | |
- | - getting autogeneration set up so PHP-GTK docs are generated on a regular basis | + | |
- | ==== Progress ==== | + | == Stage One == |
- | - Working on a fork of docgen.php | + | - < |
- | - Got appropriate markup | + | - < |
- | - Still need a theme, and no doubt other stuff | + | - Create new docgen template set for PHP-GTK. __In Progress__ |
+ | * gtk/ | ||
+ | * gtk/ | ||
+ | * < | ||
+ | * signals | ||
+ | * gtk/ | ||
+ | * gtk/ | ||
+ | * gtk/ | ||
+ | * gtk/ | ||
+ | * gtk/ | ||
+ | * gtk/ | ||
+ | - Finalize book format | ||
+ | == Stage Two == | ||
+ | - Copy as much well-formed documentation as possible from the [[http:// | ||
+ | - Fill in any glaringly-missing documentation | ||
+ | - Merge branch into phpdoc/ | ||
+ | |||
+ | === Branches === | ||
+ | [[http:// | ||
+ | |||
+ | [[http:// | ||
+ | |||
+ | [[http:// | ||
+ | |||
+ | === Reflection Idiosyncrasies === | ||
+ | PHP-GTK does not currently have proper Reflection data, beyond regular class-> | ||
+ | |||
+ | The current solution to this issue is to utilize the .defs files present in the PHP-GTK extension sources, which themselves establish which classes exist in the extension. This is done by simply reading in all of the .defs files, then regex' | ||
+ | |||
+ | === PHP-GTK-specific Constructs === | ||
+ | PHP-GTK utilizes some constructs that are not present in other extensions; or, at least, are not standard. These need to be marked up specially for PHP-GTK. | ||
+ | |||
+ | == Fields == | ||
+ | Each widget class in PHP-GTK has a set of associated properties which are separate from both its member properties and inherited properties. These " | ||
+ | |||
+ | == Signals == | ||
+ | Each widget class in PHP-GTK has a set of signals, which are essentially callback names for certain actions. One example is the GtkButton " | ||
+ | |||
+ | These signals can simply be marked up as a variant of the method format, as they are primarily callbacks. There are a [[http:// | ||
+ | * ID | ||
+ | Each signal has a signal ID associated with it. | ||
+ | * Name | ||
+ | Each signal has a name. | ||
+ | * Emitting Classes | ||
+ | The list of classes which emit that signal | ||
+ | * [[http:// | ||
+ | The signal flags are used to specify a signal' | ||
+ | * Return Type | ||
+ | * Parameters | ||
+ | Each signal handler callback accepts certain parameters, which are passed in when called. This is usually at the very least the object which emitted the signal. |
php-gtk/gtkphd.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1