Update the API documentation
authorRobert Sesek <rsesek@bluestatic.org>
Mon, 7 Jul 2008 13:43:44 +0000 (09:43 -0400)
committerRobert Sesek <rsesek@bluestatic.org>
Mon, 7 Jul 2008 13:43:44 +0000 (09:43 -0400)
* PrinterAbstract.php
(BSPrinterAbstract::setId): Document the return type
(BSPrinterAbstract::_prepareStyle): Update docs

PrinterAbstract.php

index dddabe2472d71858bcd8ca0f90ac39e3a4621f95..d06e6eb6de3cfc251e9cd9adeed0ad3c07f1880a 100644 (file)
@@ -104,6 +104,8 @@ abstract class BSPrinterAbstract
         * Sets the DOM/CSS ID of the element
         *
         * @param       string  The ID
+        *
+        * @return      fluent interface
         */
        public function setId($id)
        {
@@ -112,9 +114,9 @@ abstract class BSPrinterAbstract
        }
        
        /**
-        * Returns a string of CSS style attributes
+        * Returns a string of style attributes, that include id, style, and class
         *
-        * @return      string  CSS attributes
+        * @return      string  Style attributes
         */
        protected function _prepareStyle()
        {