Qt-interest Archive, November 2007
Doxygen and ui.h files?
Message 1 in thread
Hi...
My project consists partly of plain .h and .cpp files, partly of .ui
and .ui.h.
Like, for example, my importconflictWidget.ui, which is simply a
QDialog with two buttons and two images.
When I put
/**
\class importconflictWidget
\brief Displays two measurementviews when there's a conflict
during import
When one measurement has been changed on two different machines
(i.e. branched),
the user has to chose between overriting the old measurement or
discarding the
new version during the import.
*/
Into importconflictWidget.ui.h, the classes appears in my
doxygengenerated documention. However, none of the member functions I
describe in the ui.h file like this make it into the documentation.
/**
* Setting up the window
*
* Accepts pointers to the two Measurements the user has to decide
between.
*
* @param Measurement * import (new)
* @param Measurement * system (on disk)
*
*/
void importconflictWidget::setMeasurements( Measurement * import,
Measurement * system )
{
...
}
I don't get it.
Can someone help? I checked the doxygen manual, but to no avail. I
use 1.5.4.
Best
Peter
--
[ signature omitted ]
Message 2 in thread
How very very typical, just describing the problem helped:
I simpy forgot to add the directories for UI_DIR and MOC_DIR
dir to my Doxygen config file.
"Do'h!" No sense in looking for excuses.
Best
--
[ signature omitted ]
Message 3 in thread
On 06.11.07 18:20:39, Peter Brülls wrote:
> Hi...
>
> My project consists partly of plain .h and .cpp files, partly of .ui and
> .ui.h.
>
> Like, for example, my importconflictWidget.ui, which is simply a QDialog
> with two buttons and two images.
>
> When I put
>
>
> /**
> \class importconflictWidget
>
> \brief Displays two measurementviews when there's a conflict during
> import
>
> When one measurement has been changed on two different machines (i.e.
> branched),
> the user has to chose between overriting the old measurement or
> discarding the
> new version during the import.
>
> */
>
>
> Into importconflictWidget.ui.h,
You don't want that. ui.h is overwritten every time you change the .ui
file. Its a generated file and shouldn't be altered. Also IMHO it
doesn't make sense at all to document it, its just boilerplate code to
setup the ui you designed.
Andreas
--
[ signature omitted ]
Message 4 in thread
On Tuesday 06 November 2007 13:13:13 Andreas Pakulat wrote:
> On 06.11.07 18:20:39, Peter Brülls wrote:
> > Hi...
> >
> > My project consists partly of plain .h and .cpp files, partly of .ui and
> > .ui.h.
> >
> > Like, for example, my importconflictWidget.ui, which is simply a
> > QDialog with two buttons and two images.
> >
> > When I put
> >
> >
> > /**
> > \class importconflictWidget
> >
> > \brief Displays two measurementviews when there's a conflict during
> > import
> >
> > When one measurement has been changed on two different machines (i.e.
> > branched),
> > the user has to chose between overriting the old measurement or
> > discarding the
> > new version during the import.
> >
> > */
> >
> >
> > Into importconflictWidget.ui.h,
>
> You don't want that. ui.h is overwritten every time you change the .ui
> file. Its a generated file and shouldn't be altered. Also IMHO it
> doesn't make sense at all to document it, its just boilerplate code to
> setup the ui you designed.
I think the poster is referring to the Qt3 ui.h class extension files. There
are no ui.h files in Qt4 as the new paradigm is more like the "subclass method"
in Qt3. However, the poster has to remeber to document all the functions in
the actaual ui.h file and not in the generated uifilename.h files that lands in
UI_DIR.
--Justin
--
[ signature omitted ]
