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

Need ability to create library-level API docs without an explicit library tag. #1082

Open
Sfshaza opened this Issue Jan 13, 2016 · 11 comments

Comments

Projects
None yet
7 participants
@Sfshaza
Copy link

Sfshaza commented Jan 13, 2016

Bob suggests:

  • If there is a doc before any declarations in the library
  • and the doc comment is not directly (i.e. without a blank line) before the first declaration.

Then we treat that as the doc comment for the library.

@keertip

This comment has been minimized.

Copy link
Contributor

keertip commented Jan 13, 2016

dartdoc gets the doc comment for all elements from the analyzer. So analyzer would need to be modified to support getting doc comments from a dart file before the first declaration.

@Sfshaza, could you open a issue for the analyzer and link it in here? Thanks!

@Sfshaza

This comment has been minimized.

@munificent

This comment has been minimized.

Copy link
Member

munificent commented Jan 13, 2016

After some discussion, the new proposed rule is simpler:

Use the first doc comment attached to any directive (import, export, etc.).

@keertip

This comment has been minimized.

Copy link
Contributor

keertip commented Jan 25, 2016

This fix has been made to the analyzer. Upgrading to new analyzer package, current 0.27.1+2, will fix this issue.

@kwalrath kwalrath self-assigned this Jul 1, 2016

@devoncarew

This comment has been minimized.

Copy link
Member

devoncarew commented Jul 21, 2016

I think this is fixed?

@kwalrath

This comment has been minimized.

Copy link
Member

kwalrath commented Aug 7, 2018

I don't know if it was ever fixed.

I don't see any library comments for the stagehand docs unless I add a library statement (library stagehand;) above the imports. We removed the library statement in dart-lang/stagehand#307 (3/2016), v1.0.2, and that's when the library comments disappeared from the dartdoc: 1.0.2 library docs, 1.0.1 library docs

@kwalrath kwalrath reopened this Aug 7, 2018

@jcollins-g

This comment has been minimized.

Copy link
Collaborator

jcollins-g commented Aug 7, 2018

You're right, we still require the library statement -- if it was fixed at one point, it was before I took over.

@jcollins-g

This comment has been minimized.

Copy link
Collaborator

jcollins-g commented Aug 7, 2018

And I'm actually not right at all. This does work in dartdoc's internal tests to my surprise. Don't know why it doesn't work in your case, will require some investigation.

@jcollins-g jcollins-g added bug P2 labels Aug 7, 2018

@kwalrath

This comment has been minimized.

Copy link
Member

kwalrath commented Aug 8, 2018

Very strange. Thanks for looking into this. Please let me know if there's anything I can do to help.

@kwalrath kwalrath removed their assignment Aug 15, 2018

@natebosch

This comment has been minimized.

Copy link
Member

natebosch commented Oct 3, 2018

Any update here?

@jcollins-g

This comment has been minimized.

Copy link
Collaborator

jcollins-g commented Oct 3, 2018

AFAIK state has not changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.