Completed
Pull Request — master (#9)
by
unknown
08:34
created
code/api/thirdparty/simple_html_dom.php 1 patch
Doc Comments   +40 added lines patch added patch discarded remove patch
@@ -123,6 +123,9 @@  discard block
 block discarded – undo
123 123
     public $tag_start = 0;
124 124
     private $dom = null;
125 125
 
126
+    /**
127
+     * @param simple_html_dom $dom
128
+     */
126 129
     public function __construct($dom)
127 130
     {
128 131
         $this->dom = $dom;
@@ -1593,6 +1596,11 @@  discard block
 block discarded – undo
1593 1596
     }
1594 1597
 
1595 1598
     // parse attributes
1599
+
1600
+    /**
1601
+     * @param simple_html_dom_node $node
1602
+     * @param string[] $space
1603
+     */
1596 1604
     protected function parse_attr($node, $name, &$space)
1597 1605
     {
1598 1606
         // Per sourceforge: http://sourceforge.net/tracker/?func=detail&aid=3061408&group_id=218559&atid=1044037
@@ -1629,6 +1637,11 @@  discard block
 block discarded – undo
1629 1637
     }
1630 1638
 
1631 1639
     // link node's parent
1640
+
1641
+    /**
1642
+     * @param simple_html_dom_node $node
1643
+     * @param boolean $is_child
1644
+     */
1632 1645
     protected function link_nodes(&$node, $is_child)
1633 1646
     {
1634 1647
         $node->parent = $this->parent;
@@ -1639,6 +1652,10 @@  discard block
 block discarded – undo
1639 1652
     }
1640 1653
 
1641 1654
     // as a text node
1655
+
1656
+    /**
1657
+     * @param string $tag
1658
+     */
1642 1659
     protected function as_text_node($tag)
1643 1660
     {
1644 1661
         $node = new simple_html_dom_node($this);
@@ -1649,12 +1666,18 @@  discard block
 block discarded – undo
1649 1666
         return true;
1650 1667
     }
1651 1668
 
1669
+    /**
1670
+     * @param string $chars
1671
+     */
1652 1672
     protected function skip($chars)
1653 1673
     {
1654 1674
         $this->pos += strspn($this->doc, $chars, $this->pos);
1655 1675
         $this->char = ($this->pos<$this->size) ? $this->doc[$this->pos] : null; // next
1656 1676
     }
1657 1677
 
1678
+    /**
1679
+     * @param string $chars
1680
+     */
1658 1681
     protected function copy_skip($chars)
1659 1682
     {
1660 1683
         $pos = $this->pos;
@@ -1667,6 +1690,9 @@  discard block
 block discarded – undo
1667 1690
         return substr($this->doc, $pos, $len);
1668 1691
     }
1669 1692
 
1693
+    /**
1694
+     * @param string $chars
1695
+     */
1670 1696
     protected function copy_until($chars)
1671 1697
     {
1672 1698
         $pos = $this->pos;
@@ -1676,6 +1702,9 @@  discard block
 block discarded – undo
1676 1702
         return substr($this->doc, $pos, $len);
1677 1703
     }
1678 1704
 
1705
+    /**
1706
+     * @param string $char
1707
+     */
1679 1708
     protected function copy_until_char($char)
1680 1709
     {
1681 1710
         if ($this->char===null) {
@@ -1698,6 +1727,9 @@  discard block
 block discarded – undo
1698 1727
         return substr($this->doc, $pos_old, $pos-$pos_old);
1699 1728
     }
1700 1729
 
1730
+    /**
1731
+     * @param string $char
1732
+     */
1701 1733
     protected function copy_until_char_escape($char)
1702 1734
     {
1703 1735
         if ($this->char===null) {
@@ -1731,6 +1763,10 @@  discard block
 block discarded – undo
1731 1763
 
1732 1764
     // remove noise from html content
1733 1765
     // save the noise in the $this->noise array.
1766
+
1767
+    /**
1768
+     * @param string $pattern
1769
+     */
1734 1770
     protected function remove_noise($pattern, $remove_tag=false)
1735 1771
     {
1736 1772
         global $debug_object;
@@ -1758,6 +1794,10 @@  discard block
 block discarded – undo
1758 1794
     }
1759 1795
 
1760 1796
     // restore noise to html content
1797
+
1798
+    /**
1799
+     * @param string|null $text
1800
+     */
1761 1801
     public function restore_noise($text)
1762 1802
     {
1763 1803
         global $debug_object;
Please login to merge, or discard this patch.
code/api/MyTwitter.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
      *
78 78
      * @param String $username (e.g. mytwitterhandle)
79 79
      * @param Int $count - number of tweets to retrieve at any one time
80
-     * @return DataObjectSet | Null
80
+     * @return \SilverStripe\ORM\DataList | Null
81 81
      */
82 82
     public static function last_statuses($username, $count = 1, $useHourlyCache = true)
83 83
     {
@@ -121,7 +121,7 @@  discard block
 block discarded – undo
121 121
      *
122 122
      * @param String $username (e.g. mytwitterhandle)
123 123
      * @param Int $count - number of tweets to retrieve at any one time
124
-     * @return DataObjectSet | Null
124
+     * @return null|ArrayList | Null
125 125
      */
126 126
     public function TwitterFeed($username, $count = 5)
127 127
     {
Please login to merge, or discard this patch.
code/data/ShareThisOptions.php 1 patch
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -65,6 +65,7 @@
 block discarded – undo
65 65
     /**
66 66
      * Get's all options
67 67
      *
68
+     * @param string $title
68 69
      * @return array
69 70
      */
70 71
     public static function get_all_options($title, $link, $description)
Please login to merge, or discard this patch.
code/extension/ShareThisSiteConfigDE.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -90,7 +90,7 @@
 block discarded – undo
90 90
     /**
91 91
      * CanEditShareIcons
92 92
      *
93
-     * @return void
93
+     * @return boolean|null
94 94
      */
95 95
     public function CanEditShareIcons()
96 96
     {
Please login to merge, or discard this patch.
code/extension/ShareThisSTE.php 1 patch
Doc Comments   +4 added lines, -3 removed lines patch added patch discarded remove patch
@@ -155,7 +155,7 @@  discard block
 block discarded – undo
155 155
     }
156 156
 
157 157
     /**
158
-     * @return boolean
158
+     * @return string|null
159 159
      */
160 160
     public function getShareAll()
161 161
     {
@@ -165,7 +165,7 @@  discard block
 block discarded – undo
165 165
     }
166 166
 
167 167
     /**
168
-     * @return array
168
+     * @return ArrayList
169 169
      */
170 170
     protected function makeShareIcons($bookmarks)
171 171
     {
@@ -224,6 +224,7 @@  discard block
 block discarded – undo
224 224
 
225 225
     /**
226 226
      * Creating the bookmarks
227
+     * @param string $field
227 228
      */
228 229
     protected function makeBookmarks($field)
229 230
     {
@@ -252,7 +253,7 @@  discard block
 block discarded – undo
252 253
     }
253 254
 
254 255
     /**
255
-     * @return boolean
256
+     * @return boolean|null
256 257
      */
257 258
     private function applyToOwnerClass()
258 259
     {
Please login to merge, or discard this patch.
code/extension/SocialNetworksSTE.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -81,7 +81,7 @@  discard block
 block discarded – undo
81 81
     }
82 82
 
83 83
     /**
84
-     * @return SocialNetworkingLinksDataObject
84
+     * @return \SilverStripe\ORM\DataList
85 85
      */
86 86
     public function SocialNetworks()
87 87
     {
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
94 94
     }
95 95
 
96 96
     /**
97
-     * @return boolean
97
+     * @return boolean|null
98 98
      */
99 99
     private function applyToOwnerClass()
100 100
     {
Please login to merge, or discard this patch.
code/model/FacebookFeed_Item.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -123,7 +123,7 @@  discard block
 block discarded – undo
123 123
     }
124 124
 
125 125
     /**
126
-     * @return boolean
126
+     * @return boolean|string
127 127
      */
128 128
     public function canView($member = null)
129 129
     {
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
     }
132 132
 
133 133
     /**
134
-     * @return boolean
134
+     * @return boolean|string
135 135
      */
136 136
     public function canEdit($member = null)
137 137
     {
@@ -241,7 +241,7 @@  discard block
 block discarded – undo
241 241
     }
242 242
 
243 243
     /**
244
-     * @return FieldList $fields
244
+     * @return \SilverStripe\Forms\FieldList $fields
245 245
      */
246 246
     public function getCMSFields()
247 247
     {
Please login to merge, or discard this patch.
code/model/FacebookFeed_Page.php 1 patch
Doc Comments   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -62,7 +62,7 @@  discard block
 block discarded – undo
62 62
     ];
63 63
 
64 64
     /**
65
-     * @return boolean
65
+     * @return boolean|string
66 66
      */
67 67
     public function canCreate($member = null, $context = [])
68 68
     {
@@ -70,7 +70,7 @@  discard block
 block discarded – undo
70 70
     }
71 71
 
72 72
     /**
73
-     * @return boolean
73
+     * @return boolean|string
74 74
      */
75 75
     public function canView($member = null)
76 76
     {
@@ -78,7 +78,7 @@  discard block
 block discarded – undo
78 78
     }
79 79
 
80 80
     /**
81
-     * @return boolean
81
+     * @return boolean|string
82 82
      */
83 83
     public function canEdit($member = null)
84 84
     {
@@ -86,7 +86,7 @@  discard block
 block discarded – undo
86 86
     }
87 87
 
88 88
     /**
89
-     * @return boolean
89
+     * @return boolean|string
90 90
      */
91 91
     public function canDelete($member = null)
92 92
     {
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
94 94
     }
95 95
 
96 96
     /**
97
-     * @return FieldList $fields
97
+     * @return \SilverStripe\Forms\FieldList $fields
98 98
      */
99 99
     public function getCMSFields()
100 100
     {
Please login to merge, or discard this patch.
code/model/MyTwitterData.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
     }
78 78
 
79 79
     /**
80
-     * @return boolean
80
+     * @return boolean|string
81 81
      */
82 82
     public function canView($member = null)
83 83
     {
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
     }
94 94
 
95 95
     /**
96
-     * @return boolean
96
+     * @return boolean|string
97 97
      */
98 98
     public function canEdit($member = null)
99 99
     {
Please login to merge, or discard this patch.