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

Third party libraries filter (and associated options) #12

Closed
JeroMiya opened this issue Jun 6, 2014 · 1 comment
Closed

Third party libraries filter (and associated options) #12

JeroMiya opened this issue Jun 6, 2014 · 1 comment

Comments

@JeroMiya
Copy link

JeroMiya commented Jun 6, 2014

Splitting this issue off from this issue:
#7

Assuming that support for declarations is implemented in the above issue, a very useful companion feature would be to support for specifying some files as "third party code" (note: NOT just classifying all declaration files as third party code, but rather explicitly specifying a particular list of files or file patterns as third party code - because we might have third party code in non-declaration files and first-party code in declaration files). Then, at the top bar of the generated output page, add a new "filter" to show or hide third party code documentation.

@sebastian-lenz
Copy link
Member

Hi JeroMiya, sorry for my late reply. There definitely will be support for declaration files, actually it is already in the master and can be enabled using the --includeDeclarations switch.

So how we need to distinguish project sources from third party sources. My first idea was to simply mark all source files passed to the compiler as project sources and all files being additionally resolved by the compiler as third party sources. This works quite well as long as the project's structure strictly separates them into top-level directories.

However this schema will not always work, e.g. it does not apply the structure I'm using with a /lib/ folder within the project containing third party libraries. Easiest solution seems to be adding an option for specifying a pattern that matches third party files. Do you think that's sufficient?

I really like your idea of adding an additional filter for third party libraries. Documenting third party libraries results in huge documentations and you quickly wish to show/hide the external parts. I've added a new filter 'Externals' to the documentation output, let me know what you think of it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants