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

Is it working for "enum" and "class"? #1

Open
sneko opened this issue May 11, 2022 · 2 comments
Open

Is it working for "enum" and "class"? #1

sneko opened this issue May 11, 2022 · 2 comments
Labels
bug Something isn't working

Comments

@sneko
Copy link

sneko commented May 11, 2022

Hi @hipstersmoothie ,

I just tried your lib' but when generating the docs it brings no additional additional for enum and class definitions. I'm just seeing:

UtmParams (type)
UtmSynapse (class)

Maybe I did something wrong... was it working for you?

Thank you,

EDIT: I switched to https://typedoc.org/ at the end

@sneko sneko added the bug Something isn't working label May 11, 2022
@jakemayfield
Copy link

jakemayfield commented May 18, 2022

@sneko I experienced a result similar to yours. I'm only showing class names but nothing regarding anything of their properties or methods.

I'm looking for a solution that embeds the documentation into the README.md. Can https://typedoc.org/ do that? I was not able to find anything on it. Thanks!

@sneko
Copy link
Author

sneko commented May 18, 2022

@jakemayfield I searched a lot and didn't find something convenient.

My conclusion is:

  • the markdown generated will probably use its own logic of "title 1 (#), title 2 (##)...". Meaning when you embed it in your root markdown file (README.md) it can mess up with your text presentation (depending on your levels of titles and details you have...)
  • the definition you want to show is often just a resume, not the full details with enum values... when using a generator it's likely it will split definitions across multiple files to make it "digest" inside contexts. Merging the whole among your README.md content would render the thing huge (loosing the main purpose of a clear README.md if you have lot of definitions)

At the end I decided it would be more convenient to generate a folder to contain all definitions and pointing to it. See my repo https://github.com/sneko/utm-synapse with a mention to https://github.com/sneko/utm-synapse/blob/main/docs/TYPINGS.md . Like that each markdown file presents a context of definition.

NB: I'm new to this field, so my thoughts are limited to what I saw ^^
NB2: to know how I did, things are in the package.json and typedoc.js

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants