Skip to content
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.

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

[Bug] Apidoc #5614

Closed
mdmunir opened this issue Oct 17, 2014 · 3 comments
Closed

[Bug] Apidoc #5614

mdmunir opened this issue Oct 17, 2014 · 3 comments

Comments

@mdmunir
Copy link
Contributor

mdmunir commented Oct 17, 2014

During use apidoc, i found several bug/unexpected result.

Broken link in *.md.

I have README.md with line

- [Change Log](CHANGELOG.md).
- [Basic Usage](docs/guide/basic-usage.md).
- [Using Menu](docs/guide/using-menu.md).

in generated doc (guide-README.html) a good link only for Change Log (guide-CHANGELOG.html) but for Basic Usage and Using Menu dont. Generated link.

<li><a href="guide-CHANGELOG.html">Change Log</a>.</li>
<li><a href="docs/guide/basic-usage.md">Basic Usage</a>.</li>
<li><a href="docs/guide/using-menu.md">Using Menu</a>.</li>

Not read @property clause.

Apidoc only read setter and getter methode but no read from @propety.
I have line

 * @property Menu[] $menus 
 */

...
/**
* @return ActiveQuery
*/
public function getMenus()
{
    return $this->hasMany(...
}

generated doc is [$menus type ActiveQuery] instead of [$menus type Menu[]]

Application exit 😢

I got throw exeption try to get property of non object. No other message, no error line, just apllication exit. I need a full day to investigate this trouble. I found that is caused when we have public methode setXyz() with no parameter. can you add another good error message or error line 😀 ?

@samdark samdark added status:to be verified Needs to be reproduced and validated. ext:apidoc labels Oct 17, 2014
@cebe
Copy link
Member

cebe commented Oct 17, 2014

Broken link in *.md.

well, the apidoc was created for the yii documentation which has files in one directory only. Not sure if we can and will support this usage...

Not read @Property clause.

Could be a useful feature but has no priority because it is not used this way for the framework docs.

Application exit 😢

I do not understand the problem with this. please open a separate issue for this and give more information on how to reproduce it.

@cebe cebe added type:enhancement and removed status:to be verified Needs to be reproduced and validated. labels Oct 17, 2014
@mdmunir mdmunir mentioned this issue Oct 17, 2014
@schmunk42
Copy link
Contributor

Related #3547

@yii-bot
Copy link

yii-bot commented Jan 24, 2016

Issue moved to yiisoft/yii2-apidoc#50

@yii-bot yii-bot closed this as completed Jan 24, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants