General improvements

[rustkas]

• Tune module descrition (exclude licence topic info from generating documentation by @end EDoc tag.

• Add documentation targets for generation public and private documenation.

• -spec. Simplified documentation content. Explicitly specified the name of function parameters in a uniform style.
  Introduced a wider use of the features of EDoc.

• Provide a description of the data types (-type) that were in the source codes in the generated EDoc documentation. This in the code seems non-obvious and even strange. But please look at the output when generating the documentation. The result - we have documentation for types.

• cowmachine_req. Fix version documentation type. Arranged the version values in the correct order.

• rebar.config

  • Add documentation generation and testing profiles.
  • Add option to generate public and private documentation.
  • Moved the work with the dilyzer to a separate profile "check" from the "test" profile. It is more comfortable. It also speeds up work by doing only useful work.

• EDoc

  • Tune css stylesheet.

[mmzeeman]

Hi Rustkas,

Thanks for contributing. Cowmachine definitely needs to have some extra documentation. Is this PR ready? In the comment you mention an improved css file, but I didn't see it in the PR yet. Anyhow, I will look at your PR later today.

[rustkas]

Hi Maas!
Thanks for mentioning about the CSS. I've made adjustments to it to improve the readability of the generated documentation. I didn't make the appropriate adjustments to the .gitignore file.

This PR is ready. Now I am working with next one. I am developing property-based tests for cowmachine.

[rustkas]

Note related to the conflict into src/cowmachine.erl

dialyzer did warning message related to a piece of this request_1 function. After adding result variable warning was gone.

[mmzeeman]

🙏. I’ll run it through dialyzer with zotonic as well.

…

Sent from my iPhone

On 6 May 2022, at 19:00, Anatolii ***@***.***> wrote:  Note related to this conflict above src/cowmachine.erl dialyzer did warning message related to a piece of this request_1 function. After adding result variable warning was gone. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.

[mmzeeman]

That must have been a lot of work to add the missing specs. The new style of spec definitions look a lot clearer in the code and in the documentation. The zotonic logo is a really nice touch. 👍

[rustkas]

That must have been a lot of work to add the missing specs. The new style of spec definitions look a lot clearer in the code and in the documentation. The zotonic logo is a really nice touch. +1

Thank you Maas for a positive assessment of my work.
It would be nice to review other Zotonic related pull requests which I already did:

1. bcrypt

2. buffalo

3. dispatch_compiler

4. poolboy

   1. Documentation improvements
   2. Proper tests

5. depcache

6. erlang-certifi

7. bert.erl

[mworrell]

Released 1.9.0