Config icon indicating copy to clipboard operation
Config copied to clipboard

Convert ro Respect\Doc

Open augustohp opened this issue 13 years ago • 5 comments

Start using Respect/Doc into project, this implies into:

  • Making many public method protected
  • Creating better unit tests to be used as examples
  • Adding little PHPDoc to some classes and methods

augustohp avatar Mar 26 '12 14:03 augustohp

We can make the visibility private if you ask me, does anyone need to decorate a container? I guess its better to leave the option.

100% code coverage and travis should also be included here.

What is the state of Respect\Doc doesn't it require some special type of tests? (examples if I recall)

nickl- avatar Feb 07 '13 05:02 nickl-

We only need to change visibility of things that aren't meant to be documented. Anything that may be useful as a public attribute (even if there are risks) I believe should be kept public. The risks can be reduced by testing (which improves our docs)! =)

Respect\Doc requires a special test method naming and suggests a test body that can be used as an example, but we only implemented a few of the several patterns for naming we imagined.

alganet avatar Feb 07 '13 13:02 alganet

I'm on it, also rewriting tests to use a stream wrapper and get 100% coverage completed.

I think the Respect/Doc compatibility should be handled as a separate milestone, driven from that project to render docs for all our projects and not influence the completion of this milestone at all, agreed?

nickl- avatar Feb 08 '13 14:02 nickl-

+1 for separate milestone

alganet avatar Feb 08 '13 16:02 alganet

Created new milestone and issue at Respect/Doc#18

Issue remains open for 100% coverage.

nickl- avatar Feb 08 '13 17:02 nickl-