Skip to content

Remove cc license from default footer-text #1262

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

Closed
damien-git opened this issue Oct 21, 2016 · 10 comments · Fixed by #1515
Closed

Remove cc license from default footer-text #1262

damien-git opened this issue Oct 21, 2016 · 10 comments · Fixed by #1515
Labels
P2 A bug or feature request we're likely to work on

Comments

@damien-git
Copy link

Pages generated by dartdoc have the following footer (which is not changed with the --footer option): the name of the application, the Dart icon, and "cc license". My application is not distributed under the cc license, but this makes it look like it is. Is there any way to change that ?

@devoncarew
Copy link
Member

No feature for that currently, but you can post-process the generated docs.

I believe that cc license isn't meant to apply to the package, but to the generated docs.

@damien-git
Copy link
Author

Then maybe dartdoc could write "Dart" or "generated by dartdoc" instead of the package name before the license.

@sethladd
Copy link
Contributor

Good idea. Patches welcome!

@kevmoo
Copy link
Member

kevmoo commented Sep 16, 2017

@devoncarew @jcollins-g We should change the default here. We shouldn't guess the license.

We could add a field to the pubspec that contains dartdoc-specific info, like the doc license.

@jcollins-g
Copy link
Contributor

I think licensing information probably does belong in pubspec.yaml because it isn't dartdoc specific. I don't want dartdoc-specific options in pubspec.yaml; instead, I'm planning a dartdoc_options.yaml similar to analysis_options.yaml.

@kevmoo
Copy link
Member

kevmoo commented Sep 18, 2017

Sure. I guess if a package author wants tweak things there they can.

The "default" should be nothing – again, we shouldn't be guessing for the user.

@jcollins-g jcollins-g changed the title license Remove cc license from default footer-text Sep 18, 2017
@jcollins-g
Copy link
Contributor

A simple change to dartdoc + a change to the SDK when upgrading the version is required here.

@jcollins-g jcollins-g added P2 A bug or feature request we're likely to work on user feedback labels Sep 18, 2017
@kevmoo
Copy link
Member

kevmoo commented Sep 18, 2017

Glad it's simple 😄

@kwalrath
Copy link
Contributor

dartdoc_options.yaml sounds great. What do you think would be there?

@jcollins-g
Copy link
Contributor

@kwalrath I want to place there most options that are currently command line flags, such as header/footer, whether to group categories, etc. Additionally, similar to analyzer, I want a section for controlling dartdoc warnings and which to treat as errors or warnings. The code is actually almost ready for that breakout but we need somewhere nice to land the configuration options rather than just greatly expanding our command line flags:

Map<PackageWarning, PackageWarningHelpText> packageWarningText = {

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 A bug or feature request we're likely to work on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants