Bug 82 – DocGenerator does not create .rst files when headers are not found

PySide Bugzilla Closed for New Bugs

PySide is now a Qt Add-on and uses the Qt Project's JIRA Bug Tracker instead of this Bugzilla instance. This Bugzilla is left for reference purposes.

Bug 82 - DocGenerator does not create .rst files when headers are not found

Summary:

DocGenerator does not create .rst files when headers are not found

Status:	CLOSED INVALID

Product:	PySide
Classification:	Unclassified
Component:	Documentation
Version:	0.2.1
Platform:	All All

Importance:	P5 enhancement
Assigned To:	renato filho

URL:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2009-10-22 15:07 EEST by Bruno Araujo
Modified:	2010-10-13 13:53 EEST (History)
CC List:	6 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Bruno Araujo 2009-10-22 15:07:02 EEST

If you try to run docgenerator for a module, e.g. phonon, and the C++ headers
of this module are not available or not specified correctly for the generator
executable, the generator will complain with warnings in the following fashion:


WARNING :: type 'Phonon::MediaObjectInterface' is specified in typesystem, but
not defined. This could potentially lead to compilation errors.
WARNING :: type 'Phonon::VolumeSlider' is specified in typesystem, but not
defined. This could potentially lead to compilation errors.
WARNING :: type 'Phonon::SubtitleDescription' is specified in typesystem, but
not defined. This could potentially lead to compilation errors.
(...)

The last one, near the end of the output, is the following:

WARNING :: Can't find qdoc3 file for module , tried:
/home/bruno/projects/git/open/baraujo-pyside/build/doc/qt4xmldoc/.xml

After all these warnings, the generation will proceed, but in the end no
documentation for the module will be generated, for no immediately apparent
reason. The docgenerator should provide a message saying explicitly that the
headers are missing and the generation cannot proceed, maybe exiting with an
error.

For reproducing this issue, just run "make <module>-apidoc" to generate the
.rst sources, if the headers are missing the warnings above will appear.

Comment 1 Hugo Parente Lima 2010-09-23 16:49:52 EEST

We can't abort the doc generation when no classes were found because you can
bind a module with just global functions without any class. So I'm changing the
status to invalid.