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

@packageDocumentation for typedoc #67

Closed
samchon opened this issue Apr 18, 2020 · 2 comments
Closed

@packageDocumentation for typedoc #67

samchon opened this issue Apr 18, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@samchon
Copy link
Owner

samchon commented Apr 18, 2020

TypeDoc has been updated and the update has a break change. To define the virtual module with typedoc-plugin-external-module-name, @packageDocumentation must be addicted like below:

/**
 * @packageDescription
 * @module std
 */
@samchon samchon added the documentation Improvements or additions to documentation label Apr 18, 2020
@samchon samchon self-assigned this Apr 18, 2020
samchon pushed a commit that referenced this issue Apr 18, 2020
samchon pushed a commit that referenced this issue Apr 18, 2020
samchon pushed a commit that referenced this issue Apr 18, 2020
@samchon
Copy link
Owner Author

samchon commented Apr 21, 2020

79690039-5967ce00-8293-11ea-8665-7fbe92b5959f

I've succeeded to using the virtual module with typedoc-plugin-external-module-name after adding the @packageDescription tags. However, another problem has been occured. TypeDoc has implemented newly feature references and the references is harming the virtual module.

Therefore, I've to find the way to hiding the references features. I've posted an issue to the TypeDoc, answering the way, how to hide the references - TypeStrong/typedoc#1271

@samchon
Copy link
Owner Author

samchon commented Apr 21, 2020

To solve this problem, I've published a temporary npm module typedoc-plugin-exclude-references, a type of plugin for the TypeDoc. With the new plugin, I could hide the references section.

samchon pushed a commit that referenced this issue May 13, 2020
@samchon samchon closed this as completed May 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant