TanmayPatil105 / procfetch

🎨 Yet another command-line system information utility written in C++
https://tanmaypatil105.github.io/procfetch/
GNU General Public License v3.0
23 stars 11 forks source link

Intro doxygen #58

Closed youpong closed 2 years ago

youpong commented 2 years ago

Description

Introduce API documentation by doxygen.

Dependencies

$ apt install doxygen graphviz

How to generate the API docs

exec below on top directory of the project.

$ make docs
codecov-commenter commented 2 years ago

Codecov Report

Merging #58 (e415add) into main (db52342) will increase coverage by 0.20%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #58      +/-   ##
==========================================
+ Coverage   22.71%   22.91%   +0.20%     
==========================================
  Files           4        4              
  Lines         383      384       +1     
==========================================
+ Hits           87       88       +1     
  Misses        296      296              
Impacted Files Coverage Δ
src/fetch.h 91.11% <100.00%> (+0.20%) :arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

TanmayPatil105 commented 2 years ago

Looks Good to me! Any way to add other functions to docs?

youpong commented 2 years ago

For other functions, templates are provided in pull request #60. Add explanations to them.

TanmayPatil105 commented 2 years ago

Yup working on it!