MS-267 Documentation for NIFs #100
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In spec file `spec`ed functions can be decorated with `@doc` and its documentation will be inherited by the end-user Elixir functions.
Create new test_project with documented spec functions
I thought functionally
integration tests
Fix tests from the main dir
FelonEkonom
requested changes
Oct 27, 2022
lib/unifex/specs_dsl.ex
Outdated
| \"\"\" | ||
| spec function_name... | ||
| """ | ||
| defmacro @{:doc, [line: _line], [documentation]} do |
There was a problem hiding this comment.
Suggested change
| defmacro @{:doc, [line: _line], [documentation]} do | |
| defmacro @{:doc, _meta, [documentation]} do |
|
What about generating docs for CNodes? It would be nice to have docs also when somebody is not using NIF |
|
Please add a reference to related Jira ticket |
FelonEkonom
reviewed
Oct 27, 2022
Previous version filled function's documentation with `"false`" string.
`elixir_sense` is removed from the testing project and it is no longer pulled from the GitHub
the warning message
Remove `elixir_sense` dep
FelonEkonom
requested changes
Nov 3, 2022
Remove predefined `documented` sub project
`Membrane.Logger` is meant to be used in elements.
FelonEkonom
approved these changes
Nov 8, 2022
Janix4000
force-pushed
the
nifs-documentation
branch
from
a991414
to
aa7ddd5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Final Elixir functions, created by Unifex, can now be documented using the
@docdecorator in thespecfile.