silverstripe / silverstripe-framework

api/RSSFeed.php

Doc Comments +3 added lines, -1 removed lines

@@ -191,7 +191,7 @@ 
 	 *
 	 * TODO: Pass $response object to ->outputToBrowser() to loosen dependence on global state for easier testing/prototyping so dev can inject custom SS_HTTPResponse instance.
 	 *
-	 * @return	HTMLText
+	 * @return	DBField
 	 */
 	public function outputToBrowser() {
 		$prevState = Config::inst()->get('SSViewer', 'source_file_comments');
@@ -222,6 +222,7 @@ 
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;
@@ -318,6 +319,7 @@ 
 	/**
 	 * Return the named field as an obj() call from $this->failover.
 	 * Default to the given class if there's no casting information.
+	 * @param string $fieldName
 	 */
 	public function rssField($fieldName, $defaultClass = 'Varchar') {
 		if($fieldName) {

model/DataObject.php

Doc Comments +10 added lines, -4 removed lines

@@ -558,8 +558,8 @@ 
 
 	/**
 	 * Helper function to duplicate relations from one object to another
-	 * @param $sourceObject the source object to duplicate from
-	 * @param $destinationObject the destination object to populate with the duplicated relations
+	 * @param DataObject $sourceObject the source object to duplicate from
+	 * @param DataObject $destinationObject the destination object to populate with the duplicated relations
 	 * @param $name the name of the relation to duplicate (e.g. members)
 	 */
 	private function duplicateRelations($sourceObject, $destinationObject, $name) {
@@ -957,6 +957,7 @@ 
 	 * @param $includeRelations Boolean Merge any existing relations (optional)
 	 * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values.
 	 *                            Only applicable with $priority='right'. (optional)
+	 * @param DataObject|null $rightObj
 	 * @return Boolean
 	 */
 	public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) {
@@ -2243,6 +2244,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2721,6 +2723,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -3067,7 +3070,7 @@ 
 	 * Traverses to a field referenced by relationships between data objects, returning the value
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
-	 * @param $fieldName string
+	 * @param string $fieldName string
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3136,7 +3139,7 @@ 
 	 * @param string $callerClass The class of objects to be returned
 	 * @param string|array $filter A filter to be inserted into the WHERE clause.
 	 * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-	 * @param string|array $sort A sort expression to be inserted into the ORDER
+	 * @param string $sort A sort expression to be inserted into the ORDER
 	 * BY clause.  If omitted, self::$default_sort will be used.
 	 * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
 	 * @param string|array $limit A limit expression to be inserted into the LIMIT clause.
@@ -3346,6 +3349,8 @@ 
 	/**
 	 * @see $sourceQueryParams
 	 * @param array
+	 * @param string $key
+	 * @param string $value
 	 */
 	public function setSourceQueryParam($key, $value) {
 		$this->sourceQueryParams[$key] = $value;
@@ -3353,6 +3358,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

control/Controller.php

Doc Comments +4 added lines, -3 removed lines

@@ -132,6 +132,7 @@ 
 	 * {@inheritdoc}
 	 *
 	 * Also set the URLParams
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$return = parent::setRequest($request);
@@ -372,7 +373,7 @@ 
 	 *
 	 * @param string $action
 	 *
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function defaultAction($action) {
 		return $this->getViewer($action)->process($this);
@@ -508,7 +509,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return DBField
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -673,7 +674,7 @@ 
 	 * Tests whether a redirection has been requested. If redirect() has been called, it will return
 	 * the URL redirected to. Otherwise, it will return null.
 	 *
-	 * @return null|string
+	 * @return boolean
 	 */
 	public function redirectedTo() {
 		return $this->getResponse() && $this->getResponse()->getHeader('Location');

control/RequestHandler.php

Doc Comments +6 added lines, -1 removed lines

@@ -121,6 +121,7 @@ 
 
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -238,6 +239,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -271,7 +275,7 @@ 
 	 *
 	 * Must not raise SS_HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param SS_HTTPRequest $request
 	 * @param $action
 	 * @return SS_HTTPResponse
 	 */
@@ -384,6 +388,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);