Review Request 115325: Improve documentation of KWindowInfo

[Alex Merry]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/115325/#review48743
-----------------------------------------------------------

Ship it!


Looks good, other than the one issue below:


src/kwindowinfo.h
<https://git.reviewboard.kde.org/r/115325/#comment34411>

    Remove the space before @endlink; otherwise, doxygen makes the space following the word part of the link


As for tooling, the easiest way is to run
/path/to/kapidox/src/kgenapidox /path/to/kwindowsystem
and you should get a "kwindowsystem-apidocs" folder in your current directory.  That contains a html directory with the documentation, and a doxygen-warnings.log file.

There are a couple of different ways to have kapidox installed, so that kgenapidox is on your PATH, but they generally require either modifying your PATH or modifying Python's system search path.

- Alex Merry


On Feb. 1, 2014, 8:30 a.m., Martin Gräßlin wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/115325/
> -----------------------------------------------------------
> 
> (Updated Feb. 1, 2014, 8:30 a.m.)
> 
> 
> Review request for KDE Frameworks.
> 
> 
> Repository: kwindowsystem
> 
> 
> Description
> -------
> 
> Improve documentation of KWindowInfo
> 
> The documentation was a little bit sparse and outdated.
> 
> 
> Diffs
> -----
> 
>   src/kwindowinfo.h 1e4a45895b567b4844b05cc3e848d773b6846910 
> 
> Diff: https://git.reviewboard.kde.org/r/115325/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Martin Gräßlin
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140201/5bd55d8c/attachment-0001.html>