The main way is to either have the diagrams in-line via @dot/@enddot or @msc/@endmsc or to reference an external file @dotfile or @mscfile.
The latter allows for easier reuse of diagrams. I'll have more detail and examples up a little later. On 03/24/2015 06:12 PM, ???(Uze Choi) wrote: > Hi June (Release Management functional leader) > > I think, you are responsible to decide what kind of context API > Documentation should contain and format also. > Please give us the guideline regarding the documentation. > > Jon, Could you explain little bit detail how to merge the output of those > tools together into the final Doxygen file. > > BR, Uze Choi > -----Original Message----- > From: iotivity-dev-bounces at lists.iotivity.org [mailto:iotivity-dev- > bounces at lists.iotivity.org] On Behalf Of Lankswert, Patrick > Sent: Wednesday, March 25, 2015 12:38 AM > To: Jon A. Cruz; iotivity-dev at lists.iotivity.org > Subject: Re: [dev] Documentation tools > > Jon, > > This is a good suggestion. Let's get some move feedback from the group. > > If there are no negative votes, I would like to add these when we have > content that leverages them so that we can validate the integration. > > Pat > >> -----Original Message----- >> From: iotivity-dev-bounces at lists.iotivity.org [mailto:iotivity-dev- >> bounces at lists.iotivity.org] On Behalf Of Jon A. Cruz >> Sent: Monday, March 23, 2015 5:22 PM >> To: iotivity-dev at lists.iotivity.org >> Subject: [dev] Documentation tools >> >> >> Hi, >> >> We currently list Doxygen as the main tool required for our code >> documentation. In order to extend our capabilities and also to help >> add to the design/architecture aspects of the documentation it would >> be good to add graphviz and mscgen to the required tools. >> >> Graphviz/dot allows us to embed diagrams in Doxygen including UML >> sketches and other things that make life easier for developers. It >> uses a > very >> simple format that is easy to pickup and to modify. Mscgen generates >> message sequence charts and is also directly supported by Doxygen as >> of v 1.5.2. >> >> One of the main benefits to using these to generate diagrams and >> charts is that they are automatically kept in sync with the code and >> get updated > each >> time docs are built. Another, and the one that makes it better than >> using external diagramming tools, is that Doxygen will automatically >> hot-link > the >> items in the charts and diagrams to the pertinent sections of >> generated documentation. >> >> Are there any reasons we shouldn't pick up the use of these two? Of >> course they will only be required for actual documentation builds and >> not for the core product. >> >> -- >> Jon A. Cruz - Senior Open Source Developer Samsung Open Source Group >> jonc at osg.samsung.com _______________________________________________ >> iotivity-dev mailing list >> iotivity-dev at lists.iotivity.org >> https://lists.iotivity.org/mailman/listinfo/iotivity-dev > -- Jon A. Cruz - Senior Open Source Developer Samsung Open Source Group jonc at osg.samsung.com
