search

OmicronProject / BakeoutController

Backend application to control the temperature and pressure control for introduction into a vacuum chamber
MIT License
0 stars 1 forks source link

Doxygen manual build fixes #5 #32

Closed MichalKononenko closed 7 years ago

MichalKononenko commented 7 years ago

Added a Doxygen build to this project,

Doxygen parses the src directories to build API documentation. It uses the file extension to identify the required parser (.cpp for C++, .java for Java, etc.), parses the code, and renders markup in the comments into HTML documentation.

Custom content can be included in Markdown or HTML.

This PR aims to fix issue #5.

I tried to automate the build process, but I found it requiring of a bit more attention than I initially expected. If this PR gets approved, I'm going to open an issue to automate the documentation build. This gist offers some insight into how to do it. The author's solution was to write a shell script, but I believe the required scripting can be done in Gradle as well.

codecov-io commented 7 years ago

Current coverage is 100% (diff: 100%)

Merging #32 into master will not change coverage

@@           master   #32   diff @@
===================================
  Files           1     2     +1   
  Lines           2    11     +9   
  Methods         0     0          
  Messages        0     0          
  Branches        0     0          
===================================
+ Hits            2    11     +9   
  Misses          0     0          
  Partials        0     0

Powered by Codecov. Last update 93d3a67...eefe01c