Page MenuHomePhabricator

Fix doxygen warnings in Wikispeech
Open, Needs TriagePublic1 Estimated Story Points

Description

When running doxygen in the Wikispeech directory (using composer doc) the following warnigns are returned

1/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechSegment.php:19: warning: Compound MediaWiki::Wikispeech::Api::ApiWikispeechSegment is not documented.
2/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:33: warning: Compound MediaWiki::Wikispeech::Api::ApiWikispeechListen is not documented.
3/vagrant/mediawiki/extensions/Wikispeech/includes/Hooks/WikispeechHooks.php:26: warning: Compound MediaWiki::Wikispeech::Hooks::WikispeechHooks is not documented.
4/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:35: warning: member with no name found.
5/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:38: warning: member with no name found.
6/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:41: warning: member with no name found.
7/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:44: warning: member with no name found.
8/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:47: warning: member with no name found.
9/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:50: warning: member with no name found.
10/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:53: warning: member with no name found.
11/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechSegment.php:21: warning: member with no name found.
12/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/CleanedText.php:22: warning: documented symbol `MediaWiki\Wikispeech\Segment\CleanedText::string' was not declared or defined.
13/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/CleanedText.php:31: warning: documented symbol `MediaWiki\Wikispeech\Segment\CleanedText::string' was not declared or defined.
14/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/Cleaner.php:27: warning: documented symbol `MediaWiki\Wikispeech\Segment\Cleaner::array' was not declared or defined.
15/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/Cleaner.php:35: warning: documented symbol `MediaWiki\Wikispeech\Segment\Cleaner::array' was not declared or defined.
16/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/Cleaner.php:43: warning: documented symbol `MediaWiki\Wikispeech\Segment\Cleaner::array' was not declared or defined.
17/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/Segmenter.php:30: warning: documented symbol `MediaWiki\Wikispeech\Segment\Segmenter::IContextSource' was not declared or defined.
18/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/Segmenter.php:37: warning: documented symbol `MediaWiki\Wikispeech\Segment\Segmenter::array' was not declared or defined.
19/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/Segmenter.php:50: warning: member with no name found.
20/vagrant/mediawiki/extensions/Wikispeech/includes/SpeechoidConnector.php:22: warning: member with no name found.
21/vagrant/mediawiki/extensions/Wikispeech/includes/SpeechoidConnector.php:25: warning: member with no name found.
22/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJob.php:24: warning: member with no name found.
23/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJob.php:27: warning: member with no name found.
24/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:50: warning: member with no name found.
25/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:53: warning: member with no name found.
26/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:56: warning: member with no name found.
27/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:59: warning: member with no name found.
28/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:62: warning: member with no name found.
29/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:65: warning: member with no name found.
30/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByLanguageAndVoiceJob.php:24: warning: member with no name found.
31/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByLanguageAndVoiceJob.php:27: warning: member with no name found.
32/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByLanguageAndVoiceJob.php:30: warning: member with no name found.
33/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByLanguageAndVoiceJob.php:33: warning: member with no name found.
34/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByPageIdJob.php:24: warning: member with no name found.
35/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByPageIdJob.php:27: warning: member with no name found.
36/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByPageIdJob.php:30: warning: member with no name found.
37/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:39: warning: member with no name found.
38/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:42: warning: member with no name found.
39/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:47: warning: documented symbol `FileBackend Used to store utterance audio and synthesis MediaWiki\Wikispeech\Utterance\UtteranceStore::metadata' was not declared or defined.
40/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:52: warning: documented symbol `MediaWiki\Wikispeech\Utterance\UtteranceStore::ILoadBalancer' was not declared or defined.
41/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:57: warning: documented symbol `MediaWiki\Wikispeech\Utterance\UtteranceStore::SpeechoidConnector' was not declared or defined.
42/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:61: warning: member with no name found.
43/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:64: warning: member with no name found.
44/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:99: warning: documented symbol `MediaWiki\Wikispeech\Utterance\UtteranceStore::getFileBackend' was not declared or defined.
45/vagrant/mediawiki/extensions/Wikispeech/includes/VoiceHandler.php:22: warning: member with no name found.
46/vagrant/mediawiki/extensions/Wikispeech/includes/VoiceHandler.php:25: warning: member with no name found.
47/vagrant/mediawiki/extensions/Wikispeech/includes/VoiceHandler.php:28: warning: member with no name found.
48/vagrant/mediawiki/extensions/Wikispeech/includes/VoiceHandler.php:31: warning: member with no name found.
49/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:35: warning: member with no name found.
50/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:38: warning: member with no name found.
51/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:41: warning: member with no name found.
52/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:44: warning: member with no name found.
53/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:47: warning: member with no name found.
54/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:50: warning: member with no name found.
55/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:53: warning: member with no name found.
56/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:56: warning: member with no name found.
57/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:59: warning: member with no name found.
58/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:62: warning: member with no name found.
59/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:65: warning: member with no name found.
60/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:68: warning: member with no name found.
61/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:71: warning: member with no name found.
62/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:74: warning: member with no name found.
63/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:77: warning: member with no name found.
64/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:80: warning: member with no name found.
65/vagrant/mediawiki/extensions/Wikispeech/maintenance/flushUtterances.php:34: warning: member with no name found.
66/vagrant/mediawiki/extensions/Wikispeech/maintenance/flushUtterances.php:37: warning: member with no name found.
67/vagrant/mediawiki/extensions/Wikispeech/maintenance/flushUtterances.php:40: warning: member with no name found.
68/vagrant/mediawiki/extensions/Wikispeech/maintenance/flushUtterances.php:43: warning: member with no name found.
69/vagrant/mediawiki/extensions/Wikispeech/maintenance/flushUtterancesByExpirationDateOnFile.php:33: warning: member with no name found.
70/vagrant/mediawiki/extensions/Wikispeech/maintenance/flushUtterancesByExpirationDateOnFile.php:36: warning: member with no name found.
71/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:19: warning: Member $IP (variable) of namespace MediaWiki::Wikispeech is not documented.
72/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:20: warning: Member if($IP===false) (variable) of namespace MediaWiki::Wikispeech is not documented.
73/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:476: warning: Member $maintClass (variable) of namespace MediaWiki::Wikispeech is not documented.
74/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/CleanedText.php:25: warning: Member $string (variable) of class MediaWiki::Wikispeech::Segment::CleanedText is not documented.
75/vagrant/mediawiki/extensions/Wikispeech/includes/Segment/CleanedText.php:34: warning: Member $path (variable) of class MediaWiki::Wikispeech::Segment::CleanedText is not documented.
76/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:60: warning: Member $cacheKeyClass (variable) of class MediaWiki::Wikispeech::Utterance::FlushUtterancesFromStoreByExpirationJobQueue is not documented.
77/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/FlushUtterancesFromStoreByExpirationJobQueue.php:63: warning: Member $cacheKeyComponentPreviousDateTimeQueued (variable) of class MediaWiki::Wikispeech::Utterance::FlushUtterancesFromStoreByExpirationJobQueue is not documented.
78/vagrant/mediawiki/extensions/Wikispeech/includes/Utterance/UtteranceStore.php:40: warning: Member UTTERANCE_TABLE (variable) of class MediaWiki::Wikispeech::Utterance::UtteranceStore is not documented.

Event Timeline

Most of these are probably caused by @var expecting the format @var datatype $varname\n Description rather than @var datatype Description which we and the rest of MediaWiki uses. This is T36457 and should probably be fixed by making sure we hook in to /maintenance/mwdocgen.php

After shoehorning in the filter MediaWiki makes use of the warnings drop down to only

/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechSegment.php:19: warning: Compound MediaWiki::Wikispeech::Api::ApiWikispeechSegment is not documented.
/vagrant/mediawiki/extensions/Wikispeech/includes/Api/ApiWikispeechListen.php:33: warning: Compound MediaWiki::Wikispeech::Api::ApiWikispeechListen is not documented.
/vagrant/mediawiki/extensions/Wikispeech/includes/Hooks/WikispeechHooks.php:26: warning: Compound MediaWiki::Wikispeech::Hooks::WikispeechHooks is not documented.
/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:19: warning: Member $IP (variable) of namespace MediaWiki::Wikispeech is not documented.
/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:20: warning: Member if($IP===false) (variable) of namespace MediaWiki::Wikispeech is not documented.
/vagrant/mediawiki/extensions/Wikispeech/maintenance/benchmark.php:476: warning: Member $maintClass (variable) of namespace MediaWiki::Wikispeech is not documented.

Change 641426 had a related patch set uploaded (by Lokal Profil; owner: Lokal Profil):
[mediawiki/extensions/Wikispeech@master] Make sure MediaWiki input filter for doxygen is used by composer

https://gerrit.wikimedia.org/r/641426

Lokal_Profil set the point value for this task to 1.Dec 3 2020, 8:47 AM

Change 641426 merged by jenkins-bot:
[mediawiki/extensions/Wikispeech@master] Make sure MediaWiki input filter for doxygen is used by composer

https://gerrit.wikimedia.org/r/641426

Left to do is addressing any remaining, relevant warnigns

kalle added a subscriber: kalle.Thu, Jan 14, 11:16 AM

Run it again to see if T267148 managed to get these warnings go away.