I have used both mscgen and graphviz in Doxygen docs before and found them useful. If done right, the mscgen sequence charts can be readable in the comments in the source, so they are also useful to developers browsing the files instead of the documents.
There is a Doxygen option that turns on generation of class diagrams using graphviz, so getting graphviz content is easy. Bill. > -----Original Message----- > From: iotivity-dev-bounces at lists.iotivity.org [mailto:iotivity-dev- > bounces at lists.iotivity.org] On Behalf Of Lankswert, Patrick > Sent: Tuesday, March 24, 2015 11: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
