Générer Protobuf de la documentation?

Question

Est-ce quelqu'un connais un bon outil pour générer Google Protobuf de la documentation à l'aide de l' .proto fichiers sources?

Markus

Answer 1

Open source protobuf plugin qui génère DocBook et PDF à partir de la proto fichiers.

http://code.google.com/p/protoc-gen-docbook/

Avertissement: je suis l'auteur du plugin.

Answer 2

Dans Protobuf 2.5 "//" les commentaires que vous mettez dans votre .proto fichiers rend effectivement dans le code source java généré que des commentaires Javadoc. Plus spécifiquement, le protoc compilateur va prendre votre "//" les commentaires de ce genre:

// 
// Message level comments
message myMsg {

    // Field level comments
    required string name=1;
}

allez dans votre générés les fichiers source java. Pour une raison quelconque protoc entoure les commentaires Javadoc en <pre> tags. Mais dans l'ensemble c'est une belle nouvelle fonctionnalité v2.5.

Answer 3

Doxygen soutient donc appelés filtres d'entrée, qui vous permettent de transformer le code en quelque chose de doxygen comprend. La rédaction d'un tel filtre pour transformer le Protobuf IDL en code C++ (par exemple) vous permettent d'utiliser toute la puissance de Doxygen dans .proto fichiers. Voir point 12 de l' Doxygen FAQ.

J'ai fait quelque chose de similaire pour CMake, le filtre d'entrée se transforme tout simplement CMake les macros et les fonctions de C les déclarations de fonction. Vous pouvez le trouver ici.

Answer 4

Le fil est vieux, mais la question semble toujours pertinente. J'ai eu de très bons résultats avec Doxygen + proto2cpp. proto2cpp fonctionne comme un filtre d'entrée pour Doxygen.

Answer 5

Depuis l' .proto fichier est principalement déclaration, j'ai l'habitude de trouver que le fichier source avec les commentaires en ligne est simple et efficace de la documentation.