There's no convention for this currently.  If you want to see how Google
documents things, look at descriptor.proto:

http://protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto

<http://protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto>But
it's not very exciting.

2009/11/2 Romain Fran├žois <francoisrom...@free.fr>

>
> Hi,
>
> What is the recommended way to include some documentation within the
> proto file ?
>
> Something like this perhaps.
>
> /**
>  * a person
>  */
> message Person {
>   /** identifier */
>   required int32 id = 1;
>
>   /** Name of the person. first name and last name */
>   required string name = 2;
>
>   /** email address */
>   optional string email = 3;
> }
>
> I realize there are no API to grab these from the FooDescriptor objects,
> but maybe something is planned ?
>
> Romain
>
> --
> Romain Francois
> Professional R Enthusiast
> +33(0) 6 28 91 30 30
> http://romainfrancois.blog.free.fr
> |- http://tr.im/BcPw : celebrating R commit #50000
> |- http://tr.im/ztCu : RGG #158:161: examples of package IDPmisc
> `- http://tr.im/yw8E : New R package : sos
>
>
> >
>

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Protocol Buffers" group.
To post to this group, send email to protobuf@googlegroups.com
To unsubscribe from this group, send email to 
protobuf+unsubscr...@googlegroups.com
For more options, visit this group at 
http://groups.google.com/group/protobuf?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to