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.

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

Add links to code refs in docs #3025

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add links to code refs in docs #3025

wants to merge 1 commit into from

Conversation

amomchilov
Copy link
Contributor

@amomchilov amomchilov commented Aug 30, 2024 •
edited
Loading

image

amomchilov
amomchilov commented Aug 30, 2024
View reviewed changes
include/prism.h
* * <code>#pm_parser_t</code> - the main parser structure
* * `pm_parser_init()` - initialize a parser
* * `pm_parse()` - parse and return the root node
* * `pm_node_destroy()` - deallocate the root node returned by `pm_parse()`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, I can't find pm_node_destroy in the docs (and neither can Doxygen. Any clue what's up with that?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know

amomchilov
amomchilov commented Aug 30, 2024
View reviewed changes
include/prism/util/pm_string.h
@@ -35,18 +35,18 @@ typedef struct {
size_t length;

/** The type of the string. This field determines how the string should be freed. */
enum {
enum pm_string_type {
Copy link
Contributor Author

@amomchilov amomchilov Aug 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This anonymous enum made broke the docs, but also gave worse in-editor feedback.

Before:

Screenshot 2024-08-30 at 2 48 58 PM

After:

image

@amomchilov amomchilov force-pushed the amomchilov/linkify-docs branch from d991608 to 0f10178 Compare August 30, 2024 19:07
@amomchilov
Copy link
Contributor Author

/home/runner/work/prism/prism/include/prism/util/pm_string.h:52: warning: Member type (variable) of struct pm_string_t is not documented.

Hmmmmm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kddnewton kddnewton kddnewton left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@amomchilov @kddnewton