Review Request 115262: Split Mainpage.dox up
Alex Merry
kde at randomguy3.me.uk
Thu Jan 23 16:46:09 UTC 2014
> On Jan. 23, 2014, 4:33 p.m., Michael Palimaka wrote:
> > README.md, line 69
> > <https://git.reviewboard.kde.org/r/115262/diff/1/?file=235484#file235484line69>
> >
> > In the threadweaver diff, you did escaped the #, I am not sure if that is wanted here too.
It sort of doesn't matter, in that it doesn't affect the output. But doxygen does issue a warning for it. I'm planning to put license summaries in all the README.md files, so I'll deal with these then.
- Alex
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/115262/#review48144
-----------------------------------------------------------
On Jan. 23, 2014, 4:09 p.m., Alex Merry wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/115262/
> -----------------------------------------------------------
>
> (Updated Jan. 23, 2014, 4:09 p.m.)
>
>
> Review request for KDE Frameworks and Christoph Cullmann.
>
>
> Repository: ktexteditor
>
>
> Description
> -------
>
> This matches up with the new kapidox scripts. This module was more complex than the others, hence the RR.
>
>
> Split Mainpage.dox up
>
> The front page content goes in README.md. Other pages are now in
> separate files under docs/.
>
> It would be nice to convert some or all of the documentation pages to
> markdown, so they can be easily read without running them through
> doxygen first.
>
>
> Also includes the commit:
>
> Remove the lines about "the following classes" from apidox group defs
>
> doxygen actually puts the class list *above* the description, not below
> it.
>
>
> Diffs
> -----
>
> Mainpage.dox 515d78af3e2babe155314b995f17955e6cacf65f
> README.md 82de5a260065959520f1558334d362d6ad16e167
> docs/apidocs-groups.dox PRE-CREATION
> docs/coding-guidelines.dox PRE-CREATION
> docs/design.dox PRE-CREATION
> docs/howto.dox PRE-CREATION
> docs/porting.dox PRE-CREATION
>
> Diff: https://git.reviewboard.kde.org/r/115262/diff/
>
>
> Testing
> -------
>
> All the old pages are still accessible from the main page when generating the documentation.
>
>
> Thanks,
>
> Alex Merry
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140123/5ef5deaa/attachment.html>
More information about the Kde-frameworks-devel
mailing list