-
-
Notifications
You must be signed in to change notification settings - Fork 401
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] Extends Components inputs and disabledLifeCycleHooks #505
Comments
Ok your issue is about the inheritance of a component with a class (without @component decorator). I will ad this scenario in the tool. |
@Chazing can i have the code of |
Fixed for the first 2 points. Waiting informations for |
It works great! thanks |
This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context. |
Overview of the issue
Hi
Thank you for adding a flat document option in the case of a component that inherits a base class.
We have some problems with this:
Inputs from base class are not documented in components nor in baseClass
The disableLifeCycleHooks option does not work on base class. there are LifeCycleHooks functions in the base class, and even when i use disabledLifeCycleHooks option, the functions are still visible in the child component and base class.
Inheritance functions from external libraries such as Angular are also documented. For example, the base class extends Angular's ValueAccessorBase. in the documentations apear ValueAccessorBase functions.
If the class is not in my code, I do not need to flat its functions
Many thanks for the amazing project!
Operating System, Node.js, npm, compodoc version(s)
"@compodoc/compodoc": "^1.0.9"
node v8.9.4
Angular configuration, a
package.json
file in the root folder"doc:build": "compodoc -p src/tsconfig.app.json",
"doc:serve": "compodoc -s",
"doc:buildandserve": "compodoc -p tsconfig.documentation.json -a screenshots -y doc-styles/ -s --includes markdown --hideGenerator --disableGraph --disableCoverage --disableSourceCode --disablePrivate --disableProtected --disableInternal --disableLifeCycleHooks"
Compodoc installed globally or locally ?
locally
Motivation for or Use Case
I need a flat documentation of components for usage. which can see on one page everything that needs to be done to use the component. (selector, inputs, outputs) and I don't need to describe the code. Any additional things that is in the code for internal use and those who use Componente does not need is unnecessary for me.
Reproduce the error
then run: npm run doc:buildandserve
I would be grateful if you would treat.
The text was updated successfully, but these errors were encountered: