On Fri, Jun 14, 2013 at 06:17:04PM -0700, Kevin Robert Keegan wrote:
> Ok, to many of them are blank lines, but it sounds cool.
I just want the list to see this.
This is absolutely great work. Thank you so much for filling those blanks.
It'll be a huge service to the next folks working with this code (including
you in 3 to 6 months as you know :)
> All existing Insteon files are now documented. Nearly all routines also now have documentation. Every voice command has at least some level of documentation. Finally all INI parameters are documented where they exist.
> The documentation is not always perfect nor well written, but it is certainly a start.
> You can merge this Pull Request by running:
> git pull https://github.com/krkeegan/misterhouse insteon_docs
> Or you can view, comment on it, or merge it online at:
> -- Commit Summary --
> * Insteon: Add Documentation to AllLinkDatabase File
> * Insteon: Add Documentation to BaseInsteon.pm; Fix a few things in AllLinkDatabase.pm
> * Insteon_Docs: Add Documentation to BaseInterface.pm
> * Insteon_Docs: Update Documentation for Controller.pm
> * Insteon Docs: Update IOLinc Documentation
> * Insteon Docs: Add Documentation to Irrigation; Fix Typo in IOLinc Documentation
> * Insteon Docs: Add documentation to lighting.pm
> * Insteon Docs: Add Documenation to Message.pm
> * Insteon Docs: Update Documentation in Security.pm
> * Insteon Docs: Add More Links to Connect the Documents Together
> * Insteon Docs: Missed a =cut
> * Insteon Docs: Fix Various Perldoc Errors
> * Insteon Docs: Add Documentation to Insteon.pm
> * Insteon Docs: Continue Documentation of Insteon.pm
> * Insteon Docs: Add Documentation to Insteon_PLM; Add INI Parameters
> -- File Changes --
> M lib/Insteon.pm (354)
> M lib/Insteon/AllLinkDatabase.pm (436)
> M lib/Insteon/BaseInsteon.pm (803)
> M lib/Insteon/BaseInterface.pm (292)
> M lib/Insteon/Controller.pm (70)
> M lib/Insteon/IOLinc.pm (183)
> M lib/Insteon/Irrigation.pm (175)
> M lib/Insteon/Lighting.pm (543)
> M lib/Insteon/Message.pm (314)
> M lib/Insteon/Security.pm (98)
> M lib/Insteon_PLM.pm (199)
> -- Patch Links --
"A mouse is a device used to point at the xterm you want to type in" - A.S.R.
Microsoft is to operating systems ....
.... what McDonalds is to gourmet cooking
Home page: http://marc.merlins.org/