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

generated docs: more doc type awareness #3404

Closed
andrewrk opened this issue Oct 8, 2019 · 1 comment
Closed

generated docs: more doc type awareness #3404

andrewrk opened this issue Oct 8, 2019 · 1 comment
Labels
autodoc The web application for interactive documentation and generation of its assets. contributor friendly This issue is limited in scope and/or knowledge of Zig internals. docs
Milestone

Comments

@andrewrk
Copy link
Member

andrewrk commented Oct 8, 2019

Extracted from #21:

Here the semantic analysis dumper gives up:

zig/src/dump_analysis.cpp

Lines 921 to 924 in e0f0e2a

default:
jw_object_field(jw, "name");
jw_string(jw, buf_ptr(&ty->name));
break;

It should supply more type information to the docs, which can then be utilized here:

default:
if (wantHtml) {
return escapeHtml(typeObj.name);
} else {
return typeObj.name;
}

This will make more hyperlinks and syntax coloring work in the docs.

@andrewrk andrewrk added docs stage1 The process of building from source via WebAssembly and the C backend. labels Oct 8, 2019
@andrewrk andrewrk added this to the 0.6.0 milestone Oct 8, 2019
@andrewrk andrewrk added the contributor friendly This issue is limited in scope and/or knowledge of Zig internals. label Oct 8, 2019
andrewrk added a commit that referenced this issue Oct 9, 2019
@andrewrk andrewrk modified the milestones: 0.6.0, 0.7.0 Feb 18, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 14, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 14, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 14, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 14, 2020
@andrewrk andrewrk modified the milestones: 0.7.0, 0.8.0 Oct 17, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 22, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 22, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 22, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 22, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 23, 2020
s-ol added a commit to s-ol/zig that referenced this issue Oct 23, 2020
travv0 pushed a commit to travv0/zig that referenced this issue Oct 29, 2020
travv0 pushed a commit to travv0/zig that referenced this issue Oct 29, 2020
travv0 pushed a commit to travv0/zig that referenced this issue Oct 29, 2020
@andrewrk andrewrk modified the milestones: 0.8.0, 0.9.0 Nov 6, 2020
@andrewrk andrewrk modified the milestones: 0.9.0, 0.10.0 May 19, 2021
@Vexu Vexu removed the stage1 The process of building from source via WebAssembly and the C backend. label Dec 28, 2022
@Vexu Vexu added the autodoc The web application for interactive documentation and generation of its assets. label Dec 28, 2022
@andrewrk
Copy link
Member Author

Irrelevant with the new autodocs system.

@andrewrk andrewrk closed this as not planned Won't fix, can't repro, duplicate, stale May 26, 2023
@andrewrk andrewrk modified the milestones: 0.13.0, 0.11.0 Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autodoc The web application for interactive documentation and generation of its assets. contributor friendly This issue is limited in scope and/or knowledge of Zig internals. docs
Projects
None yet
Development

No branches or pull requests

2 participants