After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 770114 - Generated doc lacks all descriptions
Generated doc lacks all descriptions
Status: RESOLVED FIXED
Product: vte
Classification: Core
Component: general
0.44.x
Other Linux
: Normal major
: ---
Assigned To: VTE Maintainers
VTE Maintainers
Depends on:
Blocks:
 
 
Reported: 2016-08-18 21:10 UTC by Egmont Koblinger
Modified: 2016-09-04 11:17 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Egmont Koblinger 2016-08-18 21:10:31 UTC
https://developer.gnome.org/vte/0.44/VteTerminal.html

All the descriptions about the parameters, return value, as well as the functions themselves, are missing.
Comment 1 Christian Persch′ 2016-08-20 19:22:40 UTC
Hmm. I thought maybe the sources were not scanned, but the *.cc are listed in CFILE_GLOB, so that's not it...
Comment 2 Egmont Koblinger 2016-08-26 23:33:32 UTC
0.40.3 is good, 0.41.90 is broken (the generated html doc is there in the tarball). Let's see a git bisect...
Comment 3 Egmont Koblinger 2016-08-26 23:57:22 UTC
There are only 'skip'ped commits left to test.
The first bad commit could be any of:
b27e3ccf5133bd845aa9d9620c5d09acd4b56be0
d7149e997970899957c63463b977270f205b7471
e167d6da450c6c1a9fa9b3b10f658af23c8759bb
6ee7dd640c9124f016ae2ce351439af37b530936
958859d14ef4d94fc4735c700f550b57739f31ac
669131f41aee180e8cdb994c09264e8ba4578b18
We cannot bisect more!

(Some revisions did not build so I skipped them. To be cont'd from here...)
Comment 4 Egmont Koblinger 2016-08-27 09:27:55 UTC
958859d14ef4d94fc4735c700f550b57739f31ac is the first bad commit
commit 958859d14ef4d94fc4735c700f550b57739f31ac
Author: Christian Persch <chpe@gnome.org>
Date:   Mon Mar 30 17:54:33 2015 +0200

    all: Move to C++

:040000 040000 36772aab20949b3e730aa19c0b174b6a96f23c6b ac372836483f6c0ce33b8ec46f6ba4a4de661502 M      doc
:040000 040000 026a04e98a5eedee3ef62b1de4cf8992bb930076 9aa78ea4065167db59d801f86981592084faceeb M      src

Note: You have to apply 669131f4 to compile.
Comment 5 Egmont Koblinger 2016-08-27 09:28:44 UTC
Note: a "make clean" does not remove the generated html docs, and probably because of this, they are included in the tarballs. Is this intentional?
Comment 6 Egmont Koblinger 2016-08-27 09:45:44 UTC
Christian, could you please continue the investigation from here?

(Method signatures, deprecation facts etc. make it to the docs, so I'm really unsure whether we're facing a vte bug or a gtk-doc bug.)
Comment 7 Egmont Koblinger 2016-08-27 21:47:50 UTC
Building the docs goes like:

make[3]: Entering directory '[...]/vte/doc/reference'
  DOC   Scanning header files
  DOC   Introspecting gobjects
  DOC   Building XML
  [...]

Accordingly, the source (.cc) files seem to be ignored. The parameters' names come from the .h files (in case they mismatch in .cc and .h, which is perfectly legal), and the stock deprecation warning also depends on the presence of _VTE_DEPRECATED rather than the "Deprecated:" tag within the comment.

If I move the method documentation from the .cc file to the .h file (right above _VTE_PUBLIC or _VTE_DEPRECATED), the generated doc looks as expected.
Comment 8 Christian Persch′ 2016-08-28 18:41:13 UTC
(I'll have a look once I have a working computer again...)
Comment 9 Christian Persch 2016-09-04 11:17:08 UTC
Should be fixed now.