Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Docblocks #165

Merged
merged 8 commits into from Aug 1, 2011

Conversation

Projects
None yet
2 participants
Contributor

elinw commented Jul 31, 2011

No description provided.

@eddieajau eddieajau commented on the diff Jul 31, 2011

libraries/joomla/document/document.php
@@ -237,7 +237,7 @@ class JDocument extends JObject
* if it doesn't already exist.
*
* @param string $type The document type to instantiate
@eddieajau

eddieajau Jul 31, 2011

Contributor

Need to align the description of the type param.

@eddieajau eddieajau commented on the diff Jul 31, 2011

libraries/joomla/document/document.php
@@ -448,8 +450,8 @@ class JDocument extends JObject
/**
* Adds a script to the page
*
- * @param string $content Script
- * @param string $type Scripting mime (defaults to 'text/javascript')
+ * @param string $content Script
@eddieajau

eddieajau Jul 31, 2011

Contributor

Check there are 2 spaces after $content

@eddieajau eddieajau commented on the diff Jul 31, 2011

libraries/joomla/document/document.php
@@ -531,9 +539,11 @@ class JDocument extends JObject
/**
* Sets the global document language declaration. Default is English (en-gb).
*
- * @param string $lang
+ * @param string $lang The language to be set
@eddieajau

eddieajau Jul 31, 2011

Contributor

Check there are 2spaces after string

@eddieajau eddieajau commented on the diff Jul 31, 2011

libraries/joomla/document/document.php
@@ -598,9 +617,11 @@ class JDocument extends JObject
/**
* Sets the base URI of the document
*
- * @param string $base
+ * @param string $base The base URI to be set
@eddieajau

eddieajau Jul 31, 2011

Contributor

Check there 2spacesafter string

@eddieajau eddieajau commented on the diff Jul 31, 2011

libraries/joomla/document/document.php
@@ -804,7 +855,7 @@ class JDocument extends JObject
*
* @param string $type The renderer type
*
- * @return mixed Object or null if class does not exist
+ * @return mixed Object or null if class does not exist
@eddieajau

eddieajau Jul 31, 2011

Contributor

Check there are only 2spaces after mixed.

@eddieajau eddieajau commented on the diff Jul 31, 2011

libraries/joomla/filesystem/file.php
@@ -512,7 +515,7 @@ class JFile
/**
* Wrapper for the standard file_exists function
*
- * @param string $file File path
+ * @param string $file File path
@eddieajau

eddieajau Jul 31, 2011

Contributor

Check for 2spaces after string

Contributor

elinw commented Aug 1, 2011

There are supposed to be a minimum of two spaces as I understand the rule.

@eddieajau eddieajau added a commit that referenced this pull request Aug 1, 2011

@eddieajau eddieajau Merge pull request #165 from elinw/docblocks
Docblocks
4dda9e0

@eddieajau eddieajau merged commit 4dda9e0 into joomla:staging Aug 1, 2011

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment