Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Dec 13 23:35
    StephanBijzitter commented #497
  • Dec 13 17:23
    Gerrit0 commented #1147
  • Dec 13 13:39
    ethikz commented #1102
  • Dec 13 13:39
    ethikz commented #1102
  • Dec 13 05:04
    rxliuli commented #1147
  • Dec 13 05:02
    rxliuli edited #1147
  • Dec 13 05:00
    rxliuli commented #1147
  • Dec 13 04:57
    rxliuli commented #1147
  • Dec 13 03:54
    Gerrit0 commented #1102
  • Dec 13 03:51
    Gerrit0 commented #1147
  • Dec 13 02:53
    Gerrit0 labeled #1146
  • Dec 13 02:53
    Gerrit0 commented #1146
  • Dec 13 01:01
    rxliuli edited #1147
  • Dec 13 01:01
    rxliuli edited #1147
  • Dec 13 01:01
    rxliuli labeled #1147
  • Dec 13 01:01
    rxliuli opened #1147
  • Dec 12 14:49
    ethikz commented #1102
  • Dec 12 14:49
    ethikz commented #1102
  • Dec 11 19:32
    pirix-gh commented #842
  • Dec 11 19:31
    pirix-gh commented #842
Anthony Ciccarello
@aciccarello
I'm still here. I'm behind on issues ATM though.
Gerrit Birkeland
@Gerrit0
<-- Also very behind, I haven't looked at anything in like 3 weeks. Going to try to get caught up this weekend, I really want to get export declarations working
Anthony Ciccarello
@aciccarello
That sounds like a good goal. I'm taking some PTO this week but I'm hoping to catch up on issues.
Gerrit Birkeland
@Gerrit0
#936 is ready for another look I think
Also #1114 is a pretty simple change to make @internal work like @hidden
Sagnik Pradhan
@SagnikPradhan
Hello Everyone! But
Is this issue going to be fixed TypeStrong/typedoc#1020 ?
Gerrit Birkeland
@Gerrit0
As time permits, yes. Neither Anthony nor I have a lot of time to dedicate to the project. Since #1103 fixes it, that's the PR to watch, or if you have the time to address the concerns expressed in review that would be great too.
Sven Karliner
@karlsve
Hey can anyone suggest a theme that works well with nested files? Its a pain to have app/some/nested/folders/some.file as the printed names
Gerrit Birkeland
@Gerrit0
I'm not aware of any theme that does that nicely unfortunately, it would be a good thing to add, really would be neat to have in the default theme.
Sagnik Pradhan
@SagnikPradhan
I would really love to add some themes. But I have no experience with Handlebars. So.. Theres that.
Artem Kostiuk
@postatum
Hi everyone. Is there a way to exclude all externals except one?
Gerrit Birkeland
@Gerrit0
Currently no, though you might be able to do it with careful use of the --exclude option
g. nicholas d'andrea
@gnidan
hey, pardon me if this is documented somewhere, but I couldn't find it... is it possible to link to the root readme from within a doc comment? I've tried variations of [[index]], [[README]], etc., but no dice
Gerrit Birkeland
@Gerrit0
I don't think we have a way to do that yet, looking at MarkedLinksPlugin.ts it only seems to support linking to reflections, and the readme isn't a reflection so that won't work...
Actually, the readme is added to the project, so linking to the top level project might do it, so [["typedoc"]] (quotes included)
g. nicholas d'andrea
@gnidan
oh nice @Gerrit0 I'll try that in a bit! thanks for the suggestion
g. nicholas d'andrea
@gnidan
@Gerrit0 FYI [["typedoc"]] didn't work. relative URLs serve a decent workaround, so I guess I'll just stick with that for now
it would be nice to add documentation sections as reflections themselves, but I understand bandwidth constraints and such for this project. let me know if you want to open an issue for this
Gerrit Birkeland
@Gerrit0
By [["typedoc"]] I meant [["your project name"]]
g. nicholas d'andrea
@gnidan
ah, misunderstood. I had tried that previously (and again now)... no dice. might because I use spaces in the name? or could be any of other things
Gerrit Birkeland
@Gerrit0
It might not work, I haven't tried it yet, feel free to open an issue for this so it gets tracked and will eventually get fixed if it doesn't work
Thorben Ziemek
@thorbenziemek

Hello everyone!

One question: is it possible to generate a documentation from a single ".d.ts" file? I'm using Microsofts api-extractor to build a "rollup definition file" describing my public API and would like to feed that one into TypeDoc.

Gerrit Birkeland
@Gerrit0
You should be able to do that by running typedoc on it with --includeDeclarations set, unfortunately that will probably include a bunch of types you don't want so you'll have to also use --exclude to tell it to ignore unwanted files.
Gerrit Birkeland
@Gerrit0
@aciccarello any chance you'd be able to put together a 0.15.1 release this weekend? TS 3.7 is out and breaking people's builds even if they don't use any 3.7 features directly (#1127). I've merged in #1129 which upgrades the version + adds some tests and temporarily switched the theme dependency to my fork to keep tests passing with the necessary changes.
Gerrit Birkeland
@Gerrit0
v0.15.1 is published with support for TS 3.7 :)
Sagnik Pradhan
@SagnikPradhan
Good Work
Krisztián Balla
@krisztianb
Hi everyone.
I'm working on a TypeDoc plugin and have a question: My goal is to get all interfaces (or their names) a class is implementing without those that are implemented by base classes. What would be the best way to do this? I am asking because the implementedTypes member of the Reflection returns all implemented interfaces including the ones implemented by base classes.
Gerrit Birkeland
@Gerrit0
I was going to say your best bet is probably to listen to the event fired when a class is converted and get that directly from the class declaration, but apparently there isn't one... So the best approach right now might be to traverse the tree upwards and remove names from your original list if one of the other names in the list inherits from it
Less than ideal to be sure
Krisztián Balla
@krisztianb
Thank you. I was thinking about this approach, but thought that there might be a simpler way.
KiT
@KiT-Maverik
hey guys! does anybody know, is it possible to add information about parameter type?
Gerrit Birkeland
@Gerrit0
You can use @param <name> <description>in the doc comment of the function
Krisztián Balla
@krisztianb
On the TypeDoc site it says: The JSDoc param type is not necessary because it will be read from the TypeScript types. So I guess you cannot specify it on your own.
Krisztián Balla
@krisztianb
Can sombody tell me the versioning using with TypeDoc? The latest version is 0.15.3. I have a TypeDoc plugin that specifies version ^0.4.x as a dependency. Because of NPM's semver logic it complains about an unmet peer dependency. Can versions introduce breaking changes when the 0 (usually indicating the major version number) stays the same? Or is the second number used as the major version for TypeDoc?
Gerrit Birkeland
@Gerrit0
That plugin will almost certainly not work. There was a change in... 0.13 I think that broke plugins for older versions.
The minor version in each TypeDoc upgrade usually corresponds to a TS release (I messed up the latest one, we should technically be on 0.16). We try to avoid breaking changes (especially with output/themes), but they will happen in minor version bumps when they do. Patch versions should be consistent.
Krisztián Balla
@krisztianb
Thanks for the info. Fortunately the mentioned plugin is still working. :-)
williamkbentley
@williamkbentley
Hello. I am using a plugin called typedoc-plugin-external-module-name. It does not work due to a change in the _ts API. christopherthielen/typedoc-plugin-external-module-name#337. I was wondering the best way to fix this. Contact the plugin owner? Or should TypeDoc continue to export the method?
Gerrit Birkeland
@Gerrit0
That doesn't make sense to me... The _ts is how TypeDoc accesses internal TypeScript API's.... So you can still access that function on TypeScript, we've just stopped doing that and don't use it anymore.
That plugin fundamentally changes how TypeDoc parses comments (breaking documented module comment behavior), which feels at best rather hacky and certainly not an intended export in the first place...
Since the plugin gets the comment itself (doesn't rely on the TypeDoc comment plugin), it would probably be best fixed by just not calling TypeDoc's comment parsing in the first place.
williamkbentley
@williamkbentley
I see. I'll fork that plugin and try using only the TypeScript functions
Adam Vigneaux
@AdamVig
Hello, I am unable to use TypeDoc at the moment because I use the tsBuildInfoFile flag in my tsconfig.json. I submitted a tiny pull request that fixes the issue and I want to get eyes on it, so I thought I would share it here. Let me know if there is anything I can do to help get this merged and released.
TypeStrong/typedoc#1140
Gerrit Birkeland
@Gerrit0
Sorry for the delay @AdamVig, that slipped off my list of things to get to last weekend. I should be able to get it merged + a version published tomorrow.
Adam Vigneaux
@AdamVig
Thank you!
Gerrit Birkeland
@Gerrit0
Or today as it turns out :) Just running through a few tests locally, there's another PR I want to merge that makes a few small changes.
Gerrit Birkeland
@Gerrit0
Published :)
Krisztián Balla
@krisztianb
I would like to get a list of the names of all methods of a class. How can I access the attributes, getters, setters and methods of a reflection? Thanks in advance.
It would also be interesting to get the method's visibility (private, protected or public) and return values. Is this possible?
Krisztián Balla
@krisztianb
Would this be in reflection.children if the reflection is a class?
Gerrit Birkeland
@Gerrit0
Yep, those will all be in the children. The JSON is (mostly) the same as the internal class structure. Here's what it looks like for a class with visibility modifiers:
https://github.com/TypeStrong/typedoc/blob/master/src/test/converter/class/specs.json#L415
And here's the class: https://github.com/TypeStrong/typedoc/blob/master/src/test/converter/class/class.ts#L8
Krisztián Balla
@krisztianb
We have SonarQube checking our code and it shows 5 "bugs" in the default theme's CSS: 2x unknown media feature: min-device-pixel-ratio, 2x unknown property: overflow-scrolling and unknown property: column-break-inside.