Skip to content
This repository has been archived by the owner on Nov 26, 2017. It is now read-only.

Documentation - Variable types #569

Merged
merged 9 commits into from
Dec 2, 2011
Merged

Documentation - Variable types #569

merged 9 commits into from
Dec 2, 2011

Conversation

mbabker
Copy link
Contributor

@mbabker mbabker commented Nov 30, 2011

To better help developers, I've started reviewing the "undefined methods" inspection on PhpStorm and trying to update docblocks to more accurately reflect what each parameter type is and what is being returned. Most of these changes are based on what is commented in the docblock or based on the instance type that is being returned.

@joomla-jenkins
Copy link

Unit testing complete. There were 0 failures and 0 errors from 1872 tests and 11090 assertions.
Checkstyle analysis reported 235 warnings and 0 errors.

* @param string $control_name Control name
* @param string $name Field name
* @param string $value The date value
* @param JSimpleXMLElement &$node JSimpleXMLElement node object containing the settings for the element
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this should be JXMLElement instead of JSimpleXMLElement

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly. I'd have to get an environment set up where I'm calling JElement instances to accurately figure it out, but I'm hoping that in this instance (and the other few instances that are "properly" commented), the comment stating it's a JSimpleXMLElement is correct.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the others are also incorrect - I just don't wanted to spam ;)
JSimpleXMLElement has been deprecated and the functionality is now covered by JXMLElement which extends SimpleXMLElement (the PHP one).

@joomla-jenkins
Copy link

Build triggered by changes to the head.

Unit testing complete. There were 0 failures and 0 errors from 1872 tests and 11090 assertions.
Checkstyle analysis reported 235 warnings and 2 errors.

@joomla-jenkins
Copy link

Build triggered by changes to the head.

Unit testing complete. There were 0 failures and 0 errors from 1872 tests and 11090 assertions.
Checkstyle analysis reported 235 warnings and 0 errors.

eddieajau added a commit that referenced this pull request Dec 2, 2011
Documentation - Variable types
@eddieajau eddieajau merged commit e1c10e1 into joomla:staging Dec 2, 2011
@eddieajau
Copy link
Contributor

Thanks Michael. That's awesome work.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants