Skip to content

Fix PHP Docs #513

New issue

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

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Oct 23, 2018
Merged

Fix PHP Docs #513

merged 3 commits into from
Oct 23, 2018

Conversation

tolbon
Copy link

@tolbon tolbon commented Oct 23, 2018

Fix Some PHP Docs :

  • return tags
  • add throw Exception tags

@auto-assign auto-assign bot requested a review from Progi1984 October 23, 2018 12:38
Progi1984
Progi1984 requested changes Oct 23, 2018
View reviewed changes
Copy link
Member

@Progi1984 Progi1984 left a comment

Choose a reason for hiding this comment

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

@tolbon Wow ! Huge job. Thank you 🙏 !

Some fixes and I will merge it just after :)

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -2427,6 +2440,8 @@ private function readRecordPersistDirectoryAtom($stream, $pos)
* @param string $stream
* @param integer $pos
* @link https://msdn.microsoft.com/en-us/library/dd904856(v=office.12).aspx
* @return array
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Double "return array"

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -2450,6 +2465,8 @@ private function readRecordPerSlideHeadersFootersContainer($stream, $pos)
* @param string $stream
* @param integer $pos
* @link https://msdn.microsoft.com/en-us/library/dd923930(v=office.12).aspx
* @return array
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Double "return array"

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -2473,6 +2490,8 @@ private function readRecordPlaceholderAtom($stream, $pos)
* @param string $stream
* @param integer $pos
* @link https://msdn.microsoft.com/en-us/library/dd904899(v=office.12).aspx
* @return array
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Double "return array"

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -2496,6 +2515,8 @@ private function readRecordRecolorInfoAtom($stream, $pos)
* @param string $stream
* @param integer $pos
* @link https://msdn.microsoft.com/en-us/library/dd910800(v=office.12).aspx
* @return array
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Double "return array"

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -2519,6 +2540,8 @@ private function readRecordRoundTripHFPlaceholder12Atom($stream, $pos)
* @param string $stream
* @param integer $pos
* @link https://msdn.microsoft.com/en-us/library/dd772926(v=office.12).aspx
* @return array
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Double "return array"

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -2542,6 +2565,8 @@ private function readRecordRoundTripShapeId12Atom($stream, $pos)
* @param string $stream
* @param integer $pos
* @link https://msdn.microsoft.com/en-us/library/dd923801(v=office.12).aspx
* @return array
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Double "return array"

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -2565,6 +2590,8 @@ private function readRecordRoundTripSlideSyncInfo12Container($stream, $pos)
* @param string $stream
* @param integer $pos
* @link https://msdn.microsoft.com/en-us/library/dd908949(v=office.12).aspx
* @return array
* @return array
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Double "return array"

src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -3061,6 +3100,9 @@ private function readStructureTextCFRun($stream, $pos, $strLenRT)
* A structure that specifies the paragraph-level formatting of a run of text.
* @param string $stream
* @param integer $pos
* @param $strLenRT
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon string

Copy link
Author

Choose a reason for hiding this comment

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

You want to say int ?

Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Yes, sorry !

src/PhpPresentation/Slide/Background/Image.php Outdated
@@ -87,6 +87,7 @@ public function getExtension()
/**
* Get indexed filename (using image index)
*
* @param $numSlide
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon integer

@Progi1984 Progi1984 added this to the 0.10.0 milestone Oct 23, 2018
@tolbon
Copy link
Author

tolbon commented Oct 23, 2018

@Progi1984
I see in Writer/PowerPoint2007/PptSlides.php line 812

//@var string
//public $relationId = null;
$objWriter->writeAttribute('r:embed', ($shape->relationId + 1));

String|null + a number seems strange
maybe need concatenation operator . or convertion to int and reconvert to string...
What do you think ?

Progi1984
Progi1984 requested changes Oct 23, 2018
View reviewed changes
src/PhpPresentation/Reader/PowerPoint97.php Outdated
@@ -3061,6 +3100,9 @@ private function readStructureTextCFRun($stream, $pos, $strLenRT)
* A structure that specifies the paragraph-level formatting of a run of text.
* @param string $stream
* @param integer $pos
* @param $strLenRT
Copy link
Member

Choose a reason for hiding this comment

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

@tolbon Yes, sorry !

@Progi1984
Copy link
Member

@tolbon Yes, i know it. It must be fixed in an another branch. Thanks

@Progi1984 Progi1984 merged commit fd44180 into PHPOffice:develop Oct 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Progi1984 Progi1984 Progi1984 approved these changes

Assignees

@Progi1984 Progi1984

Labels
None yet
Milestone
1.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@tolbon @Progi1984