Skip to content

Add links to code refs in docs#3025

Closed
amomchilov wants to merge 1 commit into
ruby:mainfrom
Shopify:amomchilov/linkify-docs
Closed

Add links to code refs in docs#3025
amomchilov wants to merge 1 commit into
ruby:mainfrom
Shopify:amomchilov/linkify-docs

Conversation

@amomchilov

@amomchilov amomchilov commented Aug 30, 2024

Copy link
Copy Markdown
Contributor
image

Comment thread 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
Copy Markdown
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
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Don't know


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

@amomchilov amomchilov Aug 30, 2024

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown
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

@kddnewton

Copy link
Copy Markdown
Collaborator

Superseded by #3640

@kddnewton kddnewton closed this Sep 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants