Add documentation to proto files

[machinekoder]

Since this our Machinetalk API we should document the protbuf files and generate a documentation our of the source files e.g. with: https://github.com/estan/protoc-gen-doc

[bobvanderlinden]

Would it be a good idea to trace back what function mkwrapper is calling and use LinuxCNCs Python documentation as a base for the descriptions of the protobuf messages? That should cover the status, command and error messages.

[machinekoder]

See https://github.com/machinekit/machinetalk-protobuf/pull/35/files#diff-07c5086a92949c3ffeb6a523cc39aa5dL119 this pretty much covers it

[machinekoder]

@zultron Can you please add https://github.com/estan/protoc-gen-doc to the Machinekit repository. Seems to have proper deb package description, but is not in the repositories.

[machinekoder]

More progress https://github.com/machinekit/machinetalk-protobuf/pull/51

[mhaberler]

@strahlex is Qt5 really a requirement for building the docs?

I would have to add this to the docs formatter container for automated builds :-/

https://github.com/mhaberler/docker-jekyll-asciidoctor

pity it cannot do asciidoc

[mhaberler]

tried this on ubuntu wiley:

apt install qt5-qmake qt-sdk libprotobuf-dev protobuf-compiler
git clone --depth=1 https://github.com/mhaberler/protoc-gen-doc.git
cd protoc-gen-doc
qmake
root@8a18e63562c3:/tmp/protoc-gen-doc# qmake
Project ERROR: This program requires Qt 5.x.

any suggestions?

edit: figured. Need to add qt5-default libprotoc-dev . Builds.

[machinekoder]

Not sure whats the problem with the build but there are Ubuntu packages for this tool: https://software.opensuse.org/download.html?project=home%3Aestan%3Aprotoc-gen-doc&package=protoc-gen-doc

sudo sh -c "echo 'deb http://download.opensuse.org/repositories/home:/estan:/protoc-gen-doc/xUbuntu_15.10/ /' >> /etc/apt/sources.list.d/protoc-gen-doc.list"
sudo apt-get update
sudo apt-get install protoc-gen-doc

[machinekoder]

Should be added to README.