NEWBIE: doxygen seemingly not documenting *.c files
|
View:
New views
3 Messages
—
Rating Filter:
Alert me
|
 |
NEWBIE: doxygen seemingly not documenting *.c files
by Matthew Braun-2
::
Rate this Message:
Greetings,
I'm new to doxygen so apologies if this is basic, but my searching has not turned up any answers. I have a project, written in C, that I want to use doxygen to generate the docset for (I'm working in Xcode 3.2 under OS X 10.6). When doxygen is run during the Script build phase (using the script from here: http://developer.apple.com/tools/creatingdocsetswithdoxygen.html ) I get documentation built from comments in the .h files, but not from the *.c files. FILE_PATTERNS is null (explicitly stating *.h and *.c does nothing) and when I enable the file browser, the *.c files are listed, and when I view the code the doxygen-formatted comments are stripped out, but the related documentation is not generated. I'm using the default-generated doxygen file for 1.6.1 with the following options appended via the script: DOT_CLEANUP = YES INPUT = /Users/mjbraun/Desktop/MediaFinderX/RipMonkey OUTPUT_DIRECTORY = /Users/mjbraun/Desktop/MediaFinderX/RipMonkey/DoxygenDocs.docset GENERATE_DOCSET = YES DOCSET_BUNDLE_ID = com.Portents.TheRipMonkey OPTIMIZE_OUTPUT_FOR_C = YES RECURSIVE = YES Am I missing something very basic? It feels like I am, but for the life of me, I can't figure out what it is. Thank you for any assitance! -- Matthew Braun ------------------------------------------------------------------------------ Come build with us! The BlackBerry(R) Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9 - 12, 2009. Register now! http://p.sf.net/sfu/devconference _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
|
Re: NEWBIE: doxygen seemingly not documenting *.c files
by Paul Joireman
::
Rate this Message:
Hi Matthew, Do you have @file commands in your *.c files? Paul ----- Original Message ----- From: Matthew Braun <mjbraun@...> Date: Sunday, October 25, 2009 11:19 am Subject: [Doxygen-users] NEWBIE: doxygen seemingly not documenting *.c files To: doxygen-users@... > Greetings, > > I'm new to doxygen so apologies if this is basic, but my searching has > not > turned up any answers. > > I have a project, written in C, that I want to use doxygen to generate > the > docset for (I'm working in Xcode 3.2 under OS X 10.6). When doxygen is > run > during the Script build phase (using the script from here: > http://developer.apple.com/tools/creatingdocsetswithdoxygen.html ) I get > documentation built from comments in the .h files, but not from the *.c > files. FILE_PATTERNS is null (explicitly stating *.h and *.c does nothing) > and when I enable the file browser, the *.c files are listed, and when > I > view the code the doxygen-formatted comments are stripped out, but the > related documentation is not generated. > > I'm using the default-generated doxygen file for 1.6.1 with the following > options appended via the script: > > DOT_CLEANUP = YES > INPUT = /Users/mjbraun/Desktop/MediaFinderX/RipMonkey > OUTPUT_DIRECTORY = > /Users/mjbraun/Desktop/MediaFinderX/RipMonkey/DoxygenDocs.docset > GENERATE_DOCSET = YES > DOCSET_BUNDLE_ID = com.Portents.TheRipMonkey > OPTIMIZE_OUTPUT_FOR_C = YES > RECURSIVE = YES > > Am I missing something very basic? It feels like I am, but for the > life of > me, I can't figure out what it is. > > Thank you for any assitance! > > > -- > Matthew Braun > > > > > ------------------------------------------------------------------------------ > Come build with us! The BlackBerry(R) Developer Conference in SF, CA > is the only developer event you need to attend this year. Jumpstart your > developing skills, take BlackBerry mobile applications to market and > stay > ahead of the curve. Join us from November 9 - 12, 2009. Register now! > http://p.sf.net/sfu/devconference > _______________________________________________ > Doxygen-users mailing list > Doxygen-users@... > https://lists.sourceforge.net/lists/listinfo/doxygen-users [joireman.vcf] begin:vcard n:Joireman;Paul fn:Paul Joireman tel;fax:(630) 840-2677 tel;work:(630) 840-2550 org:AD;RF/LLRF adr:;;P. O. Box 500, MS 308;Batavia;IL;60510;USA version:2.1 email;internet:joireman@... end:vcard ------------------------------------------------------------------------------ Come build with us! The BlackBerry(R) Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9 - 12, 2009. Register now! http://p.sf.net/sfu/devconference _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
|
Re: NEWBIE: doxygen seemingly not documenting *.c files
by Matthew Braun-2
::
Rate this Message:
I must have the intelligence of a bag of hair. That was it; I had included
the @file statement in the .h file, but not in the .c. Thank you so much for the help! -- Matthew Braun On 10/25/09 3:50 PM, "Paul Joireman" <joireman@...> wrote: > > Hi Matthew, > > Do you have @file commands in your *.c files? > > Paul > ----- Original Message ----- > From: Matthew Braun <mjbraun@...> > Date: Sunday, October 25, 2009 11:19 am > Subject: [Doxygen-users] NEWBIE: doxygen seemingly not documenting *.c files > To: doxygen-users@... > > >> Greetings, >> >> I'm new to doxygen so apologies if this is basic, but my searching has >> not >> turned up any answers. >> >> I have a project, written in C, that I want to use doxygen to generate >> the >> docset for (I'm working in Xcode 3.2 under OS X 10.6). When doxygen is >> run >> during the Script build phase (using the script from here: >> http://developer.apple.com/tools/creatingdocsetswithdoxygen.html ) I get >> documentation built from comments in the .h files, but not from the *.c >> files. FILE_PATTERNS is null (explicitly stating *.h and *.c does nothing) >> and when I enable the file browser, the *.c files are listed, and when >> I >> view the code the doxygen-formatted comments are stripped out, but the >> related documentation is not generated. >> >> I'm using the default-generated doxygen file for 1.6.1 with the following >> options appended via the script: >> >> DOT_CLEANUP = YES >> INPUT = /Users/mjbraun/Desktop/MediaFinderX/RipMonkey >> OUTPUT_DIRECTORY = >> /Users/mjbraun/Desktop/MediaFinderX/RipMonkey/DoxygenDocs.docset >> GENERATE_DOCSET = YES >> DOCSET_BUNDLE_ID = com.Portents.TheRipMonkey >> OPTIMIZE_OUTPUT_FOR_C = YES >> RECURSIVE = YES >> >> Am I missing something very basic? It feels like I am, but for the >> life of >> me, I can't figure out what it is. >> >> Thank you for any assitance! >> >> >> -- >> Matthew Braun >> >> >> >> >> - >> Come build with us! The BlackBerry(R) Developer Conference in SF, CA >> is the only developer event you need to attend this year. Jumpstart your >> developing skills, take BlackBerry mobile applications to market and >> stay >> ahead of the curve. Join us from November 9 - 12, 2009. Register now! >> http://p.sf.net/sfu/devconference >> _______________________________________________ >> Doxygen-users mailing list >> Doxygen-users@... >> https://lists.sourceforge.net/lists/listinfo/doxygen-users ------------------------------------------------------------------------------ Come build with us! The BlackBerry(R) Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9 - 12, 2009. Register now! http://p.sf.net/sfu/devconference _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
| Free embeddable forum powered by Nabble | Forum Help |
