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

MS-267 Documentation for NIFs #100

Merged
merged 19 commits into from
Nov 8, 2022
Merged

MS-267 Documentation for NIFs #100

merged 19 commits into from
Nov 8, 2022

Commits on Oct 24, 2022

  1. Native function can be documented 

    In spec file `spec`ed functions can be decorated with `@doc`
and its documentation will be inherited by the end-user Elixir
functions.
    @Janix4000
    Janix4000 committed Oct 24, 2022
    Configuration menu
    Copy the full SHA
    62dff16 View commit details
    Browse the repository at this point in the history

Commits on Oct 26, 2022

  1. Test function's documentation 

    Create new test_project with documented spec functions
    @Janix4000
    Janix4000 committed Oct 26, 2022
    Configuration menu
    Copy the full SHA
    0bea3ba View commit details
    Browse the repository at this point in the history

  2. Fix and simplify doc - function association 

    I thought functionally
    @Janix4000
    Janix4000 committed Oct 26, 2022
    Configuration menu
    Copy the full SHA
    7a517cf View commit details
    Browse the repository at this point in the history

  3. Integrate documented tests with Unifex 

    integration tests
    @Janix4000
    Janix4000 committed Oct 26, 2022
    Configuration menu
    Copy the full SHA
    f66de43 View commit details
    Browse the repository at this point in the history

  4. Clean and update mix.lock

    @Janix4000
    Janix4000 committed Oct 26, 2022
    Configuration menu
    Copy the full SHA
    2413418 View commit details
    Browse the repository at this point in the history

  5. Add ElixirSense to main mix.exs 

    Fix tests from the main dir
    @Janix4000
    Janix4000 committed Oct 26, 2022
    Configuration menu
    Copy the full SHA
    02ac554 View commit details
    Browse the repository at this point in the history

Commits on Nov 2, 2022

  1. Undocumented functions have really empty doc 

    Previous version filled function's documentation with `"false`" string.
    @Janix4000
    Janix4000 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    27d5773 View commit details
    Browse the repository at this point in the history

  2. Update deps 

    `elixir_sense` is removed from the testing project
and it is no longer pulled from the GitHub
    @Janix4000
    Janix4000 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    21553ff View commit details
    Browse the repository at this point in the history

  3. An attempt to document non spec token results in 

    the warning message
    @Janix4000
    Janix4000 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    d6627bb View commit details
    Browse the repository at this point in the history

  4. Better documentation of @doc token

    @Janix4000
    Janix4000 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    7c5b514 View commit details
    Browse the repository at this point in the history

  5. Unlock unused deps

    @Janix4000
    Janix4000 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    12e57ed View commit details
    Browse the repository at this point in the history

  6. Fix credo

    @Janix4000
    Janix4000 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    ccf1068 View commit details
    Browse the repository at this point in the history

  7. Fetch function docs with Code module 

    Remove `elixir_sense` dep
    @Janix4000
    Janix4000 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    ea2f02b View commit details
    Browse the repository at this point in the history

Commits on Nov 7, 2022

  1. Better @doc warning 

    Point out file and line with wrongly documented function.
    @Janix4000
    Janix4000 committed Nov 7, 2022
    Configuration menu
    Copy the full SHA
    c680b21 View commit details
    Browse the repository at this point in the history

  2. Remove unused alias

    @Janix4000
    Janix4000 committed Nov 7, 2022
    Configuration menu
    Copy the full SHA
    34ef895 View commit details
    Browse the repository at this point in the history

  3. Move doc tests to nif sub project 

    Remove predefined `documented` sub project
    @Janix4000
    Janix4000 committed Nov 7, 2022
    Configuration menu
    Copy the full SHA
    a514c36 View commit details
    Browse the repository at this point in the history

Commits on Nov 8, 2022

  1. Remove documented test from the main tests

    @Janix4000
    Janix4000 committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    2ba3e80 View commit details
    Browse the repository at this point in the history

  2. Replace Membrane.Logger with Elixirs' one 

    `Membrane.Logger` is meant to be used in elements.
    @Janix4000
    Janix4000 committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    9445061 View commit details
    Browse the repository at this point in the history

  3. Remove meta information from the pipeline

    @Janix4000
    Janix4000 committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    aa7ddd5 View commit details
    Browse the repository at this point in the history