api doc generator #1784

Merged
merged 18 commits into from Jan 6, 2014

Conversation

Projects
None yet
3 participants
@cebe
Member

cebe commented Jan 5, 2014

This is an early draft of the api doc generator implementation.

TODO:

  • finsh the model layer to hold all information we need.
  • add all information to the offline template
  • add command runner bin file
  • make templates exchangeable
  • markdown support
  • resolve links with non fqNames (for doc types this is already done by phpDocumentor :-) )
  • resolve class internal links
  • complete support for Objects property feature
  • polish and cleanup
  • display arrays in short syntax
  • README file

fixes #62

depends on phpDocumentor/Reflection#16 to be merged.

cebe added some commits Jan 5, 2014

Merge branch 'master' into api-doc-generator
* master: (27 commits)
  fixed div/0 issue in console progress bar
  console HelpController use correct script name
  support table aliases for ActiveQuery::joinWith().
  guides fixed/improved
  CS fix
  improved fixture controller
  Added back border to debugger toolbar.
  #1788 info about retaining the default scenario
  fixes #1606
  Default name and title added to GitHub auth client.
  added classes to grid, list and detail view
  fixed basic app travis
  debugging travis
  debugging travis
  added debug toolbar background to have line separators
  fixed paths in travis.yml
  reverted 1e4c1ec to get a working debug toolbar
  fixed issue with too long th columns in debugger
  enabled acceptance tests for basic application
  run basic app functional tests within the main repo test chain
  ...

@cebe cebe referenced this pull request Jan 6, 2014

Closed

Enhance api doc generator #1797

6 of 7 tasks complete
@cebe

This comment has been minimized.

Show comment
Hide comment
@cebe

cebe Jan 6, 2014

Member

done. ready for review.

Member

cebe commented Jan 6, 2014

done. ready for review.

@qiangxue

This comment has been minimized.

Show comment
Hide comment
@qiangxue

qiangxue Jan 6, 2014

Member

It looks great to me! Do you have some example screenshots or Web pages that we can take a look?

Member

qiangxue commented Jan 6, 2014

It looks great to me! Do you have some example screenshots or Web pages that we can take a look?

@cebe

This comment has been minimized.

Show comment
Hide comment
@cebe

cebe Jan 6, 2014

Member

screenshot-2014-01-06t05 50 04

Uploaded the framework docs to my server: http://stuff.cebe.cc/yii2docs/
The template is copied and adjusted from the yii 1.1 api generator so it looks not as fresh as it could ;-).

Member

cebe commented Jan 6, 2014

screenshot-2014-01-06t05 50 04

Uploaded the framework docs to my server: http://stuff.cebe.cc/yii2docs/
The template is copied and adjusted from the yii 1.1 api generator so it looks not as fresh as it could ;-).

@cebe

This comment has been minimized.

Show comment
Hide comment
@cebe

cebe Jan 6, 2014

Member

Here are docs for the extensions: http://stuff.cebe.cc/yii2docs-extensions/

Member

cebe commented Jan 6, 2014

Here are docs for the extensions: http://stuff.cebe.cc/yii2docs-extensions/

qiangxue added a commit that referenced this pull request Jan 6, 2014

@qiangxue qiangxue merged commit 52c9256 into master Jan 6, 2014

1 check passed

default The Travis CI build passed
Details

@cebe cebe deleted the api-doc-generator branch Jan 6, 2014

@Ragazzo

This comment has been minimized.

Show comment
Hide comment
@Ragazzo

Ragazzo Jan 6, 2014

Contributor

@cebe did detail info of method works? for example when i click http://stuff.cebe.cc/yii2docs-extensions/yii_apidoc_models_basedoc.html#loadSource()-detail there is no some div with method code below or anywhere. Is it supported or i misunderstand what api-generator is? :)

Contributor

Ragazzo commented Jan 6, 2014

@cebe did detail info of method works? for example when i click http://stuff.cebe.cc/yii2docs-extensions/yii_apidoc_models_basedoc.html#loadSource()-detail there is no some div with method code below or anywhere. Is it supported or i misunderstand what api-generator is? :)

@cebe

This comment has been minimized.

Show comment
Hide comment
@cebe

cebe Jan 6, 2014

Member

yeah, the extension docs are not complete because core framework classes are missing there.

Member

cebe commented Jan 6, 2014

yeah, the extension docs are not complete because core framework classes are missing there.

@Ragazzo

This comment has been minimized.

Show comment
Hide comment
@Ragazzo

Ragazzo Jan 6, 2014

Contributor

k, so after it will be all done there will be toggle button with method code/source?

Contributor

Ragazzo commented Jan 6, 2014

k, so after it will be all done there will be toggle button with method code/source?

@cebe

This comment has been minimized.

Show comment
Hide comment
Member

cebe commented Jan 6, 2014

@cebe

This comment has been minimized.

Show comment
Hide comment
@cebe

cebe Jan 6, 2014

Member

Updated the extensions api doc. they now contain all necessary files.

Member

cebe commented Jan 6, 2014

Updated the extensions api doc. they now contain all necessary files.

@Ragazzo

This comment has been minimized.

Show comment
Hide comment
@Ragazzo

Ragazzo Jan 6, 2014

Contributor

good, but detailed code still not working, but anyway... we can live with it :)

Contributor

Ragazzo commented Jan 6, 2014

good, but detailed code still not working, but anyway... we can live with it :)

@cebe

This comment has been minimized.

Show comment
Hide comment
@cebe

cebe Jan 6, 2014

Member

What is not working? Source Code view is not implemented yet, but links between methods and properties should work. If you find bugs, please show them.

Member

cebe commented Jan 6, 2014

What is not working? Source Code view is not implemented yet, but links between methods and properties should work. If you find bugs, please show them.

@Ragazzo

This comment has been minimized.

Show comment
Hide comment
@Ragazzo

Ragazzo Jan 6, 2014

Contributor

Source Code view is not implemented yet

sorry, thought your comment was about it.

Contributor

Ragazzo commented Jan 6, 2014

Source Code view is not implemented yet

sorry, thought your comment was about it.

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