Allen Bierbaum wrote: > So you want to pull the examples inline into the class docs? Or could > we just do something like Qt where we refer to the full applications. > Doxygen would even let use have the code for that full application > example be syntax highlighted with links back to the documentation of > the classes and methods being used. > > I guess I would rather see full examples that show how to fully use the > system, then see trivial examples that still sound like tutorials to me. I think Dirk's writing on the wiki sums up my opinion pretty good as well, and they don't really agree with your point here. We need to settle on concepts and names. What we have is:
Examples: 5-10 lines of code, preferrably inline in the class dox. Perhaps referenced to from a larger 'tutorial document'? Tutorials: small but complete executables that larger concepts (like your "full examples" above), with small data. Usually less than a meg. Source could be referenced to from class dox. Demos: large applications, potentially tens of megabytes of data. Referring from class dox to the source of these is not necessary, IMHO. I..e mentioning in FBOViewport class that 'SurfaceScatterRhubarbPieDemo' extensively uses it is sufficient. Linking to the actual source is not, as there should be an example and a preferrably a small tutorial as well. I think the divisions into the three concepts are pretty sound. Do you think we need something not covered here? Do you have good reasons to change the names we will use for these concepts? Do you have better names? For sure, a tutorial could be used to 'demonstrate' a concept or so. It would just not be branded as a 'demo' (hrm... ;). I'm all for settling on different namings, if there are better alternatives. Half of design is defining concepts and defining names for said concepts, the rest is just trying not to confuse the two. ;-) Cheers, /Marcus ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys -- and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV _______________________________________________ Opensg-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/opensg-users
