| Legoktm | |
| Jul 3 2015, 1:01 AM |
| F10562945: image.png | |
| Nov 2 2017, 4:09 AM |
| F10543998: Screen Shot 2017-10-31 at 16.52.40.png | |
| Oct 31 2017, 11:53 PM |
| F10541411: image.png | |
| Oct 31 2017, 7:52 PM |
In T74454, we started auto-publishing doxygen docs for PHP at https://doc.wikimedia.org/oojs-ui/master/php/.
Except the README is mainly JS focused (mentioning npm steps) and doesn't display well in doxygen, the bottom is all shouty and bolded.
Maybe we need a separate README for PHP?
| Before | After |
|---|---|
 |  |
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| README: Fix Doxygen rendering | oojs/ui | master | +30 -28 | |
| Revert "README: Fix Doxygen markup" | oojs/ui | master | +30 -30 | |
| README: Fix Doxygen markup | oojs/ui | master | +30 -30 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Open | None | T155473 Improve documentation of OOUI | |||
| Resolved | Volker_E | T104669 Improve OOjs UI's readme in doxygen generated documentation |
Change 387532 had a related patch set uploaded (by VolkerE; owner: VolkerE):
[oojs/ui@master] README: Fix Doxygen markup
Not working as expected: https://doc.wikimedia.org/oojs-ui/master/php/
Was referring to https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_headers for my patch changes.
Indeed. We've standardised on use of <pre lang="val"> for library readmes for this reason exactly because (just like with backticks) it works on GitHub with syntax highlighting, but has the benefit of not breaking Doxygen, JSDuck, GitBlit and other software we use that involves some flavour of markdown.
I don't see a "before" screenshot on this task, but based on the rendering of an older version at https://doc.wikimedia.org/oojs-ui/v0.17.10/php/, I'm assuming it previously looked like that?
That would be contrary to the Doxygen docs...
Change 387753 had a related patch set uploaded (by Krinkle; owner: Krinkle):
[oojs/ui@master] Revert "README: Fix Doxygen markup"
@Krinkle That screenshot from v0.17.10 shows the issue brought up by @Legoktm.
Maybe mixin pre, new lines and indentation then?
<pre lang="val">
$ cd path/to…
</pre>In the meantime we were pointing out on IRC that another part of T179111 might resolve the issue as well, by moving “Release” section to Contributing.md.
@Volker_E Worth a try I suppose :) I would also try and make sure there is an empty line before the <pre> which might make a difference. And maybe also try locally first (Doxygen is pretty to install). Could be that it is specific to our version of Doxygen, in which case we could also fix it by upgrading.
Change 387753 merged by jenkins-bot:
[oojs/ui@master] Revert "README: Fix Doxygen markup"
Change 387963 had a related patch set uploaded (by VolkerE; owner: VolkerE):
[oojs/ui@master] README: Fix Doxygen rendering