Skip to content

Write documentation for classes and methods#10

Draft
ivanhercaz wants to merge 6 commits intoESP-Provisioning-BLE:mainfrom
ivanhercaz:docs_01
Draft

Write documentation for classes and methods#10
ivanhercaz wants to merge 6 commits intoESP-Provisioning-BLE:mainfrom
ivanhercaz:docs_01

Conversation

@ivanhercaz
Copy link
Copy Markdown
Collaborator

Hi!
This package is awesome and really great, I need it and I enjoy a lot to use it, so I want to do my bit! I started to write documentation (dartdoc comments) for classes and methods of the package.

I leave this PR as a draft until I think it is enough or maybe everything it's documented! If I see that it's going to take a long time, I will remove the draft status of this PR and in the future I will work in another one.

Please, review the documentation and leave comments if it is necessary, because the best documentation is the one that it is reviewed for more than one! ❤️

I will always try to write the docs based on the recommendation of Effective Dart: Documentation, to be clear but also concise about what it is necessary.

Copy link
Copy Markdown
Collaborator

@ogabrielinacio ogabrielinacio left a comment

Choose a reason for hiding this comment

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

this is good enough for me, thank you very much, it will help us increase pub points on pub.dev :)

About the first line

How about something like this?

An abstract class that must be implemented in a higher layer of software, which must have at least the following methods

@ivanhercaz
Copy link
Copy Markdown
Collaborator Author

About the first line

How about something like this?

An abstract class that must be implemented in a higher layer of software, which must have at least the following methods

I thought about using "abstract class" but I feel a bit redundant because in the generated documentation the signature already indicates it is an abstract class.

Now it is really late but soon I will review your comment and rethinking the abstract class documentation.


As a note, as this PR is going to be a bit huge, it could be really useful if we make the reviews per line using the review system and let the comments for general reviews, in that way we could have a more organized environment with threads per issues/doubts/improvements in the contributions.

What do you think?

@ivanhercaz ivanhercaz added the documentation Improvements or additions to documentation label Apr 11, 2024
@ivanhercaz ivanhercaz added type/documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants