search

hs2361 / k-means-compressor

k means clustering based image compression algorithm project for OOPL
6 stars 8 forks source link

[DOCUMENTATION] Improve Documentation #6

Open DebadityaPal opened 3 years ago

DebadityaPal commented 3 years ago

We would like to have a docstring for each function that explains the function in brief. Check out the various styles for C++ docstrings, contact maintainers to decide on which one to use.

kshitij-404 commented 3 years ago

@DebadityaPal I would like to take up this issue. Could you please assign it to me?

lata-11 commented 2 years ago

Sir can you assign me this issue?

lata-11 commented 2 years ago

We would like to have a docstring for each function that explains the function in brief. Check out the various styles for C++ docstrings, contact maintainers to decide on which one to use.

Sir I am using doxygen for creating c++ docstring. Is that fine?

hs2361 commented 2 years ago

Sir I am using doxygen for creating c++ docstring. Is that fine?

You can add docstrings to functions in the form of Doxygen-style comments. Take a look at this format for documentation which is compatible with Doxygen.