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

Fix some mistakes in doxygen docs for ding-libs. #16

Open
alexey-tikhonov opened this issue Nov 29, 2021 · 0 comments
Open

Fix some mistakes in doxygen docs for ding-libs. #16

alexey-tikhonov opened this issue Nov 29, 2021 · 0 comments

Comments

@alexey-tikhonov
Copy link
Member

Cloned from https://pagure.io/SSSD/ding-libs/issue/2307 :


Here are some review comments from Stephen but I suspect there is much more so it makes sense to have a run of it.

                          struct ini_cfgfile **file_ctx);

 /**
+ * @brief Create a configuration file object using memory buffer.

@brief Create a configuration file object from a NULL-terminated buffer.

+ *
+ * Create a file object for parsing a configuration file.
+ * Configuration will use provided memory instead of the actual file.

Configuration will use the provided memory buffer instead of a real file.

+ *
+ * A "configuration file object" is different from
+ * a "configuration object". The former stores metadata
+ * about a file the configuration data is read from,

about a file from which the configuration data is read,
(this is a very esoteric bit of English)

+ * while the latter holds the configuration itself.

while the latter holds the configuration data itself.
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

No branches or pull requests

1 participant