Update and deploy documentation for atcore.
ClosedPublic

Authored by rizzitello on Jul 22 2017, 7:47 PM.

Details

Summary

Solve T6117 . Documents are deployed to <prefix>/share/doc/atcore

  • Update Doxyfile and CMake to generate and install documents
  • Add Mainpage for doxygen generated documents
  • replace logo
  • Clean up PrintThread
  • Update Documentation for PrintThread
  • Remove setSerial and setFirmwarePlugin
  • Udate Documentation for AtCore object
  • Update IFirmware Documentation
  • Update Documentation for Temperature
  • Remove unused Enum GCode::Firmwares
  • Update Documentation for GCodeCommands
  • Update Documentation for AprinterPlugin
  • Update Documentation for GrblPlugin
  • Update Documentation for MarlinPlugin
  • Update Documentation for RepetierPlugin
  • Update Documentation for SmoothiePlugin
  • Update Documentation for SprinterPlugin
  • Update Documentation for TeacupPlugin
  • Update Documentation for SerialLayer

Diff Detail

Repository
R232 AtCore
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
rizzitello created this revision.Jul 22 2017, 7:47 PM
rizzitello edited the summary of this revision. (Show Details)Jul 22 2017, 7:54 PM
rizzitello added a subscriber: Atelier: AtCore.
rizzitello planned changes to this revision.Jul 23 2017, 3:59 PM

Sync D6854 then update functions documentation .

rizzitello updated this revision to Diff 17083.Jul 24 2017, 1:07 AM
  • replace logo
  • Update Doxyfile and CMake to generate and install documents
  • Add Mainpage for documents
  • Build documents if doxygen is found
  • Clean up PrintThread
  • Update Documentation for PrintThread
  • Remove setSerial and setFirmwarePlugin
  • Udate Documentation for AtCore object
  • Update IFirmware Documentation
  • Update Documentation for Temperature
  • Remove unused Enum GCode::Firmwares
  • Update Documentation for GCodeCommands
  • Update Documentation for AprinterPlugin
  • Update Documentation for GrblPlugin
  • Update Documentation for MarlinPlugin
  • Update Documentation for RepetierPlugin
  • Update Documentation for SmoothiePlugin
  • Update Documentation for SprinterPlugin
  • Update Documentation for TeacupPlugin
  • Update Documentation for SerialLayer
rizzitello updated this revision to Diff 17084.Jul 24 2017, 1:11 AM
  • Fix Typo in Documentation for SerialLayer
rizzitello edited the summary of this revision. (Show Details)Jul 24 2017, 1:14 AM
patrickelectric requested changes to this revision.Jul 24 2017, 1:20 AM

I will try to read all asap

doc/Doxyfile
54 ↗(On Diff #17084)

We don't have the .svg ?

1114 ↗(On Diff #17084)

Doxygen can generate Latex or html documentation, "html" as default name to the output make more sense to me.

This revision now requires changes to proceed.Jul 24 2017, 1:20 AM
rizzitello requested review of this revision.Jul 24 2017, 2:01 AM
rizzitello edited edge metadata.
rizzitello added inline comments.
doc/Doxyfile
54 ↗(On Diff #17084)

all i have is this png file

1114 ↗(On Diff #17084)

by making this folder atcore on deploy we get a nice install path of share/doc/atcore instead of /doc/share/atcore/html/

laysrodrigues added inline comments.Jul 24 2017, 2:03 AM
doc/Doxyfile
54 ↗(On Diff #17084)

You could ask for the SVG file because I have it... =|

rizzitello updated this revision to Diff 17085.Jul 24 2017, 2:25 AM
rizzitello marked an inline comment as done.
rizzitello edited the summary of this revision. (Show Details)
  • Doxyfile HTML_OUTPUT = html , install docs to share/doc/atcore
doc/Doxyfile
54 ↗(On Diff #17084)

I've now tried using the svg file but unfortunately the svg file does not show in the doxygen generated documents. Instead of a logo its just a blank space

1114 ↗(On Diff #17084)

install docs to share/docs/atcore/html

  • Rebase to master
tcanabrava accepted this revision.Jul 24 2017, 10:51 AM
rizzitello updated this revision to Diff 17123.Jul 24 2017, 3:43 PM
  • Rebase to current master
laysrodrigues accepted this revision.Jul 28 2017, 12:22 PM
This revision was automatically updated to reflect the committed changes.