26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

5BestEclipsePlugins:#1(Ecloxwith
Doxygen,GraphvizandMscgen)
PostedonJune25,2012byErichStyger

The#1awardinmylistgoestoEclox+Doxygen+Graphviz+Mscgen.Yes,itisasingleEclipseplugin
(Eclox)forDoxygen,andwithtwootherpowerfultools.Itsolvesatypicalengineeringproblem:Howto
documentmyproject?Andhowtokeepituptodate?.

Likemanyotherengineers,Idonotliketowritedocumentation.Becauseitispainful.Iwanttowritecode
andprogram.Writingdocumentationforitshouldbefuntoo.Anditshouldsolvetheproblemthatthe
documentationdoesnotmatchwhathasbeenimplemented.Imabigfanofthesinglesourceconcept:
informationhastobeinasingleplace,andnotcopiedanddistributedamongdifferentplaces.Andheremy
#1helpsmedoingthis.

Inatraditionalwaythefollowingflowisused:

1.Createadesign,specifyanddocumenttheAPI
2.Implementthesoftware
3.Writetheuserdocumentation
4.Shipit
5.Maintainandshipandagain,andagain,and

Theproblemstartswiththefact,thatrarelytheimplementationmatchestheinitialdesign.Itevengets
worseafterafewmaintenancecycles:itisveryhardtokeepthedocumentationinsyncwiththeactual
implementationandprojectsources.Andtheuserdocumentationwillbeeasilyoutofsynctoo:(.

Itisalreadyhardtowritegooddocumentedcode,andwritinggoodsourcecommentsisanartonitsown.
Whynotusingthemyprecioussourcedocumentationinthesourcesanduseitforthewritten
documentation?ThisiswhereIuseDoxygen,GraphViz,MscgenandtheEclipseEcloxplugin,allofthem
opensource.

Doxygenisacompilerwhichgeneratesdocumentationoutofsourcefiles.Graphvizisapackagetodraw
diagramsandgraphs.MscgenissimilartoGraphviz,butsimplerandoptimizedformessagesequence
diagrams.AndEcloxisanEclipsepluginwhichintegrateseverythingintoEclipse.

Installation

Herearethelinkstodownloadtheneededtools:

1.Doxygen:http://www.stack.nl/~dimitri/doxygen/orwww.doxygen.org
2.Graphviz:http://www.graphviz.org
3.Mscgen:http://www.mcternan.me.uk/mscgen/

Doxygenisrequired,Graphvizhighlyrecommended,andMscgenisoptional.

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 1/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Afterinstallingallofthem,finallytheEcloxEclipseplugin:pointEclipsetotheEcloxupdatesite:

http://download.gna.org/eclox/update/

Doxygen

WithDoxygenmyprojectsources*are*thedocumentation.Doxygenisusingthecommentsinthecodeto
generatethedocumentation.Itisacompilerwhichcompilessource(ortext)filesandextractsthe
embeddedinformation.Itsupportsmanyprogramminglanguages(C,C++,Java,),anddifferentoutput
formats:HTMLandPDFareverypopularones.

Doxygenisabletogeneratedocumentationfromstandardsources.Buttherearemultiplewaysofusing
specialcommentingstylestoextendtheinformationcreated.TheDoxygendocumentationlistsdifferent
commentingstyles.

Withthis,thefollowingsourceiscompiledbyDoxygen:

1 /*!MasksforLEDs,thisisanenum,andthevaluesarepoweroftwotomakeit
2 possibletobuildmasks.Thebitnumberalsoindicatestheportbitnumber.
3 Makesurecompilertreatsenum'sefficient(e.g.asunsignedchar,asenum
4 byANSIstandardisint).*/
5 typedefenum{
6 LED_0=(1<<0),/*<Bit0ofportforLED0*/
7 LED_1=(1<<1),/*<Bit1ofportforLED1*/
8 LED_2=(1<<2),/*<Bit2ofportforLED2*/
9 LED_3=(1<<3)/*<Bit3ofportforLED3*/
10 }LED_Set;

ItproducesthefollowingHTMLoutputdocumentation:

enumLED_SetHTMLDocumentation

Anotherexampleistodocumentfunctionswiththeirparameters:

1 /**
2 *\briefSwitchesonasetofLED.
3 *\param[in]LedsThesetofLEDtobeswitchedon.
4 */
5 voidLED_On(LED_SetLeds);
6
https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 2/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse
6
7 voidLED_On(LED_SetLeds){
8 /*!\todoimplementfunction*/
9 }

ThecorrespondingHTMLdocumentationwilllooklikethis:

LED_On()Documentation

Notethe\todowithwillautomaticallyaddedtoaToDolistinthedocumentation:

TodoList

Graphviz

Graphvizisopensourcesoftwaretocreategraphsusingthedotlanguage.Dotcodecanbeusedwith
Doxygen.WiththedotlanguageIdefinenodesandedges,andthetoolwillplacethemautomatically.For
exampleIcandefineagraphwithfollowingdotcode(examplefromthedotguide):

1 /**
2 \dot
3 digraphG{
4 main>parse>execute;
5 main>init;
6 main>cleanup;
7 execute>make_string;
8 execute>printf
9 init>make_string;
10 main>printf;
https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 3/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse
10 main>printf;
11 execute>compare;
12 }
13 \enddot
14 */

Thisthenwillcreatethefollowinggraph(source:dotguide):

smalldotgraph

Thedotlanguagemakesiteasytocreatemachinegeneratedgraphstoo.Thatwaydotisusedinmany
othertoolsasvisualizationtool.AndDoxygenisusingofdottocreatedependencygraphs:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 4/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

DependencyGraph

Anicefeatureisaswellthatthenodeshavehyperlinks:clickonanodeanitjumpstothesourcefile:).

Imusingdotinmysourcestoenrichthedocumentationwithgraphs(apicturesmaysaymorethan1000
words).BelowisanexampleDoxygen/dotcode:

1 /*!\briefKeyscanroutinewhichimplementsthestatemachine.
2 \dot
3 digraphexample_api_graph{
4 node[shape=box];
5 DBNC_KEY_IDLE[fillcolor=lightblue,style=filled,label="DBNC_KEY_IDLE"];
6 DBNC_KEY_PRESSED[fillcolor=lightblue,style=filled,label="DBNC_KEY_PRESSED"];
7 DBNC_KEY_RELEASE[fillcolor=lightblue,style=filled,label="DBNC_KEY_WAIT_RELEASE"];
8 DBNC_KEY_IDLE>DBNC_KEY_PRESSED>DBNC_KEY_RELEASE;
9 DBNC_KEY_PRESSED>DBNC_KEY_PRESSED;
10 DBNC_KEY_IDLE>DBNC_KEY_IDLE;
11 }
12 \enddot
13 */

Thiswillgeneratethefollowingoutput:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 5/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Debouncegraph

Mscgen

MscgenissimilartoGraphviz,butspecializedforMessageSequenceCharts(hencetheMscinitsname).
WithMscgenIcanaddfollowingdoxygen/msccode:

1 /**
2 \msc
3 arcgradient=8;
4 a[label="Client"],b[label="Server"];
5 axb[label="getaccel"];
6 a=>b[label="getaccel"];
7 a<=b[label="ack"];
8 a<=b[label="acceldata"];
9 \endmsc
10 */

Thiswillcreatefollowingmessagesequencediagramintomydocumentation:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 6/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

MscgenExampleChart

Mscgenisidealforanycommunicationflowdiagramsandgreatlysimplifyandenhancemydocumentation.

Eclox

AllofabovecanbeusedwithoutanyIDE.ButitisalotofmorefunwithintheEclipseframework.Andhere
iswhereEcloxcomesintoplay:EcloxisapluginwhichintegratesDoxygen(andallabovetools)into
Eclipseandmakesitreallyeasytouse:

Seamlessbuildintegration
EditorcoloringforDoxygencomments
UserinterfaceforDoxygenconfigurationfiles
Editorintegrationwithautomaticcommenting
Warning/Errorparser
Wizardtocreateconfigurationfiles

EcloxandEclipse

EcloxPlugin

EcloxautomaticallydetectsanexistingDoxygeninstallationandreportsitinthePreferences:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 7/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

DoxygenVersion

Incasethisfails,thenthislinkgivessomeguidancehowtosetthesettingsinamanualway.

SyntaxColoring

EcloxaddsaDoxygenworkspacedefaulteditortothesystem:

DoxygenWorkspacedefault

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 8/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

WiththisDoxygencommentsareinbluecolor:

Doxygensourcecoloring

DoxygenAutoComments

Whatisreallycool:EcloxautomaticallyaddscommentsinDoxgenformat.ForexampleIhavethisinmy
source:

1 intCalcPos(intcurrPos,intsteps);

ThenIsimplycanstartaDoxygencomment(e.g.with/**)andpressENTER:

1 /**
2 *
3 *@paramcurrPos
4 *@paramsteps
5 *@return
6 */
7
8 intCalcPos(intcurrPos,intsteps);

Itautomaticallycreatesthecommentblockformewithparametersandreturntype,soIonlyneedtofillin
thecontent:).

NewDoxygenConfigurationFileWizard

Doxygenneedsatextualconfigurationfile.EcloxaddsawizardtocreateoneusingthemenuFile>New>
Other>Doxyfile:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 9/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

CreatingNewDoxyFile

Doxyfile

TheDoxygenconfigurationfile(Doxyfile)isasimpletextfilewhichhascommentsinittoexplainthe
settings:

1 #Doxyfile1.7.2
2
3 #Thisfiledescribesthesettingstobeusedbythedocumentationsystem
4 #doxygen(www.doxygen.org)foraproject.
5 #
6 #Alltextafterahash(#)isconsideredacommentandwillbeignored.
7 #Theformatis:
8 #TAG=value[value,...]
9 #Forlistsitemscanalsobeappendedusing:
10 #TAG+=value[value,...]
11 #Valuesthatcontainspacesshouldbeplacedbetweenquotes("").
12
13 #
14 #Projectrelatedconfigurationoptions
15 #
16
17 #Thistagspecifiestheencodingusedforallcharactersintheconfigfile
18 #thatfollow.ThedefaultisUTF8whichisalsotheencodingusedforall
19 #textbeforethefirstoccurrenceofthistag.Doxygenuseslibiconv(orthe
20 #iconvbuiltintolibc)forthetranscoding.See
21 #http://www.gnu.org/software/libiconvforthelistofpossibleencodings.
22
23 DOXYFILE_ENCODING=UTF8
24
25 #ThePROJECT_NAMEtagisasingleword(orasequenceofwordssurrounded
26 #byquotes)thatshouldidentifytheproject.
27
https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 10/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse
27
28 PROJECT_NAME=INTRO
29
30 #ThePROJECT_NUMBERtagcanbeusedtoenteraprojectorrevisionnumber.
31 #Thiscouldbehandyforarchivingthegenerateddocumentationor
32 #ifsomeversioncontrolsystemisused.
33
34 ...

DoxyfileEditor

Doxygenneedsatextconfigurationfile(theDoxyfile).WithEcloxthereisaneditorviewforthatfile:

Ecloxdoxyfileeditor

TheBasictabofthateditorviewgivesaccesstothemostimportantsettings:TheInputdirectories(Ilist
hereallthesourcedirectoriesIwanttoprocess),theOutputFormats(IusemostlyHTML.ForPDFI
usuallyselectRTForLaTeX),DiagramsandModeselection.

ThereisabugintheEcloxplugin:itloosesthelanguagesettingsfortheOptimizeresultsfor:settings.
Butthatsnotabigdeal.

TheAdvancedTabgivesaccesstoallsettings:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 11/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

DoxyfileAdvancedTab

Compilingthedocumentation

Ecloxaddsatoolbarbutton:

Ecloxtoolbarbutton

ThebuttonautomaticallyselectstheDoxyfileofthecurrentproject.Otherwiseitispossibletoselecta
differentDoxyfile.

Generatingthedocumentationislikenormallycompilingsourcefiles:theDoxygencompilerreportswhatis
goingontotheConsoleView,andwarnings/errorsarereportedintheProblemsView.

OtherDocumentation

Itispossibletodocumentthingsoutsidethesourcefiles.Therearemanydifferentcommands,\mainpage
themostimportantone:itdefinesthemainentrypointofthedocumentation.Using\pageand\sectionisis
possibletoorganizethedocumentation,and\refisusedtoreferencelabels:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 12/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

MainpageFilewithlinkstootherfiles/pages

IfusingHTML,thenthemainentrypointforthedocumentationistheindex.html.Eclipsecomeswithabuilt
inwebbrowserwhichcanbeusedtoopenthatfile.OruseanyotherHTMLviewer:

index.htmlasdocumentationentrypoint

Summary

ThecombinationofEclipse+Eclox+Doxygen+Graphvizsimplifiesmylife:itmakesdocumentationeasyto
generate.Anditallowsmetouseasinglesourceapproach:thesourcesarethedocumentation:).

HappyEcloxing

Ranking:

Rank#1:Eclox
Rank#2:AnyEditTools
Rank#3:SystemandDesktopSearch
Rank#4:EHEP
Rank#5:WickedShell

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 13/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Advertisements

SH A R ETH IS:

Print Email Reddit Twitter Facebook 19 LinkedIn 1 Tumblr

Pinterest Google Pocket

Like
5bloggerslikethis.

R ELATED

AutomaticDocumentation CompilingDocumentation EclipseandPClint:Linticator

ThisentrywaspostedinEclipse,Tips&TricksandtaggedBuilding,Eclipse,Tips&TricksbyErich
Styger.Bookmarkthepermalink[https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1eclox
withdoxygengraphvizandmscgen/].

AboutErichStyger
Embeddedismypassion....
ViewallpostsbyErichStyger

50THOUGHTSON5BESTECLIPSEPLUGINS:#1(ECLOXWITHDOXYGEN,GRAPHVIZANDMSCGEN)

Pingback:5BestEclipsePlugins:#2(AnyEditTools)|MCUonEclipse

Pingback:5BestEclipsePlugins:#3(SystemandDesktopSearch)|MCUonEclipse

Pingback:5BestEclipsePlugins:#1(EcloxwithDoxygen,Graphvizand|Laughing

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 14/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Tom
onSeptember18,2012at15:31said:

Thanksforexplainingthis.Myworkmanytimesistakingaprojectthatpeoplearehavingproblems
withandsolvingthoseproblems.Thisisaquickandeasywaytogetthehighleveloverviewof
whatisgoingonwithoutreadingeverysingleCfile.

Like

Pingback:EditorTemplatesinEclipse|MCUonEclipse

Pingback:LowLevelCodingwithPDD(PhysicalDeviceDriver)|MCUonEclipse

Pingback:CompilingDocumentationandPresentations:LaTeX|MCUonEclipse

stony
onDecember10,2013at21:41said:

IsthereawaytointegratethegeneratedHTMLdocumentationintoEclipsewhenIpressF1?Ihave
tocodealibrarycontainingdoxygendocumentationandIwantotherdeveloperstoaccessthat
documentationaseasylyaspossible.

Like

ErichStyger
onDecember14,2013at20:25said:

Ithinkthisarticlemighthelpyoudoingthis:
http://www.vogella.com/articles/EclipseRCPHelpSystem/article.html

Like

SoftwareEngineer
onMarch7,2014at04:34said:

Youshouldaddanotehowtoconfigureecloxtogeneratepdfdocuments

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 15/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Like

ErichStyger
onMarch7,2014at08:49said:

Ithinkthisisalreadynoted?YoucannotdirectlygeneratePDFfiles(tomyknowledge).I
generateeitherRTFandthenconvertittoPDF,orusetheLaTeXoptiontogenerateoutput
forPDF.Seeaswellhttps://mcuoneclipse.com/2013/10/07/compilingdocumentationand
presentationslatex/

Like

Biet
onApril10,2014at03:28said:

Hiall,
AfterinstalledDoxygen,Graphviz,andMscgen,IpointCodewarrior10.6totheEcloxupdateside
http://download.gna.org/eclox/update/
andIgeterrorbelow

Unabletoreadrepositoryathttp://download.gna.org/eclox/update.
Unabletoreadrepositoryathttp://download.gna.org/eclox/update.
http://download.gna.org/eclox/updateisnotavalidrepositorylocation.

anyidea?

Thanks,
Biet

Like

ErichStyger
onApril10,2014at04:03said:

HiBiet,
IjusthadtoaddEcloxtomynewEclipseKeplerinstallation,andthatworkedfineforme
(http://download.gna.org/eclox/update/).Canyouverifythatyouhaveinternetaccess?
Maybetheserverwasdownforashortperiod.Canyouretryit?

Like

Biet

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 16/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

onApril21,2014at08:22said:

HiEnrich,
Thanksforreply.IamjustbeabletoinstallitonCodewarrior10.3butnoton
Codewarrior10.6,gettingthesameproblemthatIhavebefore.Iamverysurethatit
isCW10.6problem.

Like

ErichStyger
onApril21,2014at10:14said:

HiBiet,

IjustretrieditwithmyMCU10.6,andIcaninstallanduseEcloxwithoutany
problems?

Ithinktheremustbesomethingwrongwithyourmachineorinstallation.

Erich

Like

ErichStyger
onApril21,2014at10:29said:

Canyoudownloadoneofthepackagespresenton
http://home.gna.org/eclox/#packagesandthenupdateEclipsefromthepackage?

Thatwaynonetworkaccessisneeded.

Ihopethishelps,

Erich

Like

ErichStyger
onApril21,2014at10:29said:

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 17/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

AnotherthoughtIhave:doyouhaveastrangenetworkconfiguration(configureda
proxyinMCU10.6)?Somehowitisnotabletoaccesstheinternet?

Erich

Like

Anonymous
onApril12,2014at14:50said:

Excellentpost.IwascheckingconstantlythisweblogandImimpressed!

Extremelyusefulinformationspeciallythefinalphase Ihandlesuchinfo
alot.Iwasseekingthiscertaininfforaverylongtime.
Thankyouandgoodluck.

Like

Andre
onApril16,2014at07:04said:

Holyshit

Inevercamearoundtolearnmoreaboutdoxygen,butitalwayswasonmytodolist.Your
explanationherehashelpedmeagreatdealandIamreallygladIfoundit.

Iaminstallingallthenecessarytoolsandthepluginrightnowandwillusethemtobetterdocument
mymasterthesis.TheprofessorswillthankyouforleadingmetoEclox

Like

ErichStyger
onApril16,2014at11:22said:

Yes,andIalwayspassathankyoutomystudentsiftheydocumentwithdoxygen.
ActuallyusingdoxygenismandatoryinmyembeddedsystemsprogrammingcourseIteach

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 18/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Like

Nadia
onApril23,2014at15:59said:

Dearall,
Ihaveinstalledallplugins,butafterrunnigIhavegotthiserror:
error:problemsopeningmapfile
C:/Users/Nadia/workspace/C++/html/structunitex_1_1virtualfile_1_1_v_f_s___i_n_o_d_e____coll__graph.map
forinclusioninthedocs!
IfyouinstalledGraphviz/dotafterapreviousfailingrun,
trydeletingtheoutputdirectoryandrerundoxygen.

PleaseIneedyourhelp,
Thinks

Like

ErichStyger
onApril23,2014at21:17said:

Whichversionofdoxygenareyouusing?

Like

DrT
onMay2,2014at04:33said:

ThisarticleisreallyaboutEcloxwiththeproperadditionalpluginsnecessaryforittoworkfullyor
almostfully,soIwasabitdisappointed.

ItwouldbegreatifitgeneratedPDFdocumentationbyclickingthe@.Itdoesnt.Youfirstneedto
installLATEX(fullseemstoberequired)andmaybe10GBto20GBlateryoucangenerateitoutside
ofEclox.ButisntthatthesortofthingthatanIDEissupposedtodoforyou?Withabitof
polishingupandoptimizingdefaultsfornewbiesithaspotentialtobeanicedevelopmenttoollike
javadoc.

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 19/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Like
ErichStyger
onMay2,2014at11:47said:

DoxygenisreallyprimarilyaboutgeneratingHTML(whichworksgreat).PDFiseitherover
.rtfofLaTeX.ButLaTeXisreallysomethingforadvancedusers.Soyoumightbebetterto
takethe.rtfandthenconvertthefileintoapdfinaseparatestep.

Like

Pingback:ConstructingaClassroomIDEwithEclipseforARM|MCUonEclipse

Stuart
onJune13,2014at03:06said:

Hithere!Verygoodpost!Pleasekeepusupdated!

Like

Pingback:AutomaticDocumentationGeneration:DoxygenwithProcessorExpert|MCUonEclipse

Shenzhen
onSeptember4,2014at15:54said:

IdliketouseecloxformyJavacode(AndroidApps)buteverytimewhenitrytoadoxyfileigetthe
errorDoxygenError
Anerroroccuredwhilerunningdoxyge.eclox.core.doxygen.RunException:

Like

ErichStyger
onSeptember4,2014at16:22said:

notsurewhatiscausingthis.WhatversionofEclipseareyouusing?IusedEcloxwith
JunoandKepler.

Like

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 20/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Shenzhen
onSeptember4,2014at16:44said:

IalsouseJuno.AtthemomentIcreatedtheDoxyfilewithDoxywizardandcopied
theDoxywizardintotheproject.Inthiswayitworks.Butforanewprojectineedto
createthedoxyfilewithdoxywizardagain.

Like

ErichStyger
onSeptember4,2014at19:30said:

Ok,Isee.Yes,youneedtocreatethat.doxyfilesomehowfirst.WhatIusuallydois
acopyitfromapreviousproject,andthenchangeit.ThatwayIdonotneedtorun
thedoxywizardagain.

Like

racomrcortes
onNovember5,2014at23:22said:

HiErich,
AfterinstalledDoxygen,Graphviz,MscgenandEcloxupdate
WhenIcompilethedocumentation
Ihavethiswarningmessage:
Warning:thedottoolcouldnotbefoundatC:\ProgramFiles\Graphviz2.38\bin
Thedot.exeisinstalledinC:\ProgramFiles\Graphviz2.38\bin

WhatcanIdo?

Thanks
RaulCortes

Like

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 21/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

racomrcortes
onNovember6,2014at04:48said:

ImissthequotesinthepathC:\ProgramFiles\Graphviz2.38\binnowisworkinggreat
Thanks
RaulCortes

Like

ErichStyger
onNovember6,2014at07:36said:

HiRaul,
Yes,ifyourpathhasspaces,youneedtoputitintodoublequotes.Gladtohearthatyou
havesolvedit!
Erich

Like

Chrisse
onDecember23,2014at10:56said:

Greatarticlethatisreallyrelevantandhelpfullformydailywork!
Thanks!

Like

Carlos
onFebruary22,2015at07:26said:

Imnewtothis,doxygenisrunningwellbutidontknowwheretoaddthegraphvizpath,anyhelpto
knowwhereshouldiaddit?

Like

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 22/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

ErichStyger
onFebruary22,2015at08:48said:

HiCarlos,
itshouldhavebeenautomaticallyaddedtotheWindowsPATHenvironmentvariablebythe
Graphvizinstaller.CanyoucheckifitispresentinthePATHofyourwindows?Ifnot,you
needtoadditmanuallythere.
Ihopethishelps.

Like

acutetech
onSeptember5,2015at11:33said:

Hmmmapuzzle.Ivejustinstalledthesecomponents.InsomeplacesthecoolEcloxauto
commentfeatureyoudescribeworks.Onotherplacesitdoesnotwork.Someexperimentssuggest
itdoesnotworkinsidean#if#endifblock.Anyknowledgeorworkaroundsforthis?

Like

ErichStyger
onSeptember5,2015at12:05said:

HiCharles,
yes,thatautocommentonlyseemstoworkinsomeplaces,andnotforeveryfunction.Ido
nothaveaworkaroundforthis.Ithinktheimplementationoftheautocommentonlycovers
themostcommoncases,andastheEcloxpluginisnowunmaintainedforseveralyears,I
doubtthatitwillbefixed.Itisashamethatnobodyhasbeenabletopickupthatplugin
work:(.

Like

acutetech
onSeptember5,2015at12:18said:

ThesetoolsworkOKonsomesmallprojects.AsItrytorunDoxygenonamediumsizedprojectI
get***Buildaborted!Aninternalerroroccurredduring:DoxygenBuild
https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 23/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

[/HBM1_GPRS2/Documentation/doxygen/pex.doxyfile].andadialogboxsaysAninternalerror
occurredduring:DoxygenBuild[/HBM1_GPRS2/Documentation/doxygen/pex.doxyfile].
endRulewithoutmatchingbeginRule:L/HBM1_GPRS2/Documentation/doxygen/pex.doxyfile

GooglesuggeststheseoriginatewithinEclipseratherthanbeingspecifictoDoxygen.Isthereany
prospectofresolvingthis?IamusingKepler.Doxygenhasbeenreportingmanywarningssuchas
thefollowingIdontknowiftheyarerelated:
C:/Freescale/EWorkspace2/HBM1_GPRS2/Generated_Code/WDog1.c:105:warning:Unsupported
xml/htmltagfound

Like

ErichStyger
onSeptember5,2015at12:30said:

Maybeitisaboutheapsize(seehttps://mcuoneclipse.com/2015/07/31/improveeclipse
performancewithincreasedheapsize/)orawindowslimitationonthecommandlinelength?
Canyoucheckintheconsoleifthecommandlinelengthisover8192characterswhereit
fails?

Like

acutetech
onSeptember5,2015at14:13said:

Theheapsizebardoesnotreachthemaximum.Iincreasedthemaximumheapsize
anyway,butthatdidnotfixtheproblem.HowdoIviewthecommand?Myconsole
seemstobeoutputtingstatusmessagesonly,andnotcommands.PerhapsIneed
notresolvethis,assubstantialamounts(all?)ofthedocumentationseemstobe
generated.

Like

ErichStyger
onSeptember6,2015at10:06said:

yes,indeedtheconsoleonlywritesthestatusmessages.Ithoughtitwritesthe
commandlinestoo.Notsureifthishelps,butIhadinthepastsomeproblemswith
differentversionsofdoxygen(compiler),butnotsureifthisisthecasehere.

Like

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 24/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

Pingback:UsingDoxygenWithinEclipsetoDocumentProjects|bitknitting

mkh38510
onJune21,2016at03:34said:

HiErich,
ItlookslikeEcloxisnowbeingmaintainedongithubbyAndreBossert.Thelocationis
https://github.com/anb0s/eclox.Ihaventtriedityet.
Mike

Like

ErichStyger
onJune21,2016at08:10said:

HiMike,
interesting,thanksforthatinformationandlink.Ihopethatwiththisitwillworkforthe
upcomingEclipsereleases.
Erich

Like

mohdsadiq
onOctober8,2016at16:06said:

Ihavecandjavasourcodewithoutdoxygencomments,IsitECLOXcanadd
doxygencommentautomatically

Like

ErichStyger
onOctober8,2016at17:45said:

No,Ecloxwontchangeyoursources.EcloxisafrontendfordoxygeninEclipse.
Butdoxygencancreatedocumentationfromyoursourcesevenifitdoesnothave
specialdoxygencommentsinit.Thedoxygencommentshelpthetool,butitworks
toacertaindegreeaswellwithoutit.

Like

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 25/26
26/3/2017 5BestEclipsePlugins:#1(EcloxwithDoxygen,GraphvizandMscgen)|MCUonEclipse

mohdSadiq
onOctober9,2016at05:34said:

Hiall,
ThanksErichStygerforthereply

IhavelargeSourceCode(candjava)addingdoxygencommentsmanuallywillbetime
consuming,Lookingforatoolwhichcanadddoxygencommentsinmysourcecodeandlaterican
fillthedescriptioninit(@briefsbeforefunction,macro,structuresetc),
Isthereanysuchtoolswhichcanadddoxygencommentinthesourcecode.

Thanks

Like

ErichStyger
onOctober9,2016at05:40said:

TheEcloxpluginhasafunctionalitywhichaddsthe@briefetc.Butyouhavetoputthe
enterkeyfirst,soitisinteractive.Imnotawareofatoolwhichdoeswhatyouwant.

Like

https://mcuoneclipse.com/2012/06/25/5besteclipseplugins1ecloxwithdoxygengraphvizandmscgen/ 26/26