Skip to content

rustdoc doesn't display values for inlined constants #15821

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.

Sign up for GitHub

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

Jump to bottom
Closed
tomjakubowski opened this issue Jul 20, 2014 · 1 comment · Fixed by #19774
Closed

rustdoc doesn't display values for inlined constants #15821

tomjakubowski opened this issue Jul 20, 2014 · 1 comment · Fixed by #19774
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tomjakubowski
Copy link
Contributor

For example, given foo.rs:

pub const MAGIC: u32 = 0xDEADBEEF;

And bar.rs:

extern crate foo;

pub use MAGIC = foo::MAGIC;

The generated rustdocs for bar.rs show something like:

Constants

pub const MAGIC: u32 =
@tomjakubowski tomjakubowski mentioned this issue Dec 7, 2014
Closed
@tomjakubowski tomjakubowski changed the title rustdoc doesn't display values for inlined statics rustdoc doesn't display values for inlined constants Dec 12, 2014
@tomjakubowski tomjakubowski mentioned this issue Dec 12, 2014
Merged
tomjakubowski added a commit to tomjakubowski/rust that referenced this issue Dec 12, 2014
@tomjakubowski
rustdoc: Properly inline const items
25223c8 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821
@tomjakubowski
Copy link
Contributor Author

Updated to reflect the static -> const split.

brson added a commit to brson/rust that referenced this issue Dec 12, 2014
@brson
rollup merge of rust-lang#19774: tomjakubowski/rustdoc-consts-statics
eb2ce7f 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821

r? @alexcrichton
brson added a commit to brson/rust that referenced this issue Dec 13, 2014
@brson
rollup merge of rust-lang#19774: tomjakubowski/rustdoc-consts-statics
5b4ba62 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821

r? @alexcrichton
brson added a commit to brson/rust that referenced this issue Dec 15, 2014
@brson
rollup merge of rust-lang#19774: tomjakubowski/rustdoc-consts-statics
3673486 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821

r? @alexcrichton
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

rustdoc: Properly inline const items tomjakubowski/rust
2 participants
@tomjakubowski @huonw