'Re: Review Request 119745: Hide member documentation for classes in imports'

[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-frameworks-devel
Subject:    Re: Review Request 119745: Hide member documentation for classes in imports
From:       "David Edmundson" <david () davidedmundson ! co ! uk>
Date:       2014-08-12 21:15:10
Message-ID: 20140812211510.14668.29479 () probe ! kde ! org
[Download RAW message or body]

--===============0503474373942087332==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit

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

(Updated Aug. 12, 2014, 9:15 p.m.)

Status
------

This change has been marked as submitted.

Review request for KDE Frameworks and Plasma.

Repository: plasma-framework

Description
-------

These classes are exposed only as QML so we should only show members the
user can actually use.

The invokable is moved to the top so we only need one block to hide things.

It's not great having to add tags manually, but it's the best I've found; especially \
as we can't just hide member variables as we need Q_INVOKABLES. If this gets approved \
I'll do the other plasma docs.

Diffs
-----

  src/declarativeimports/core/framesvgitem.h 117d10c 

Diff: https://git.reviewboard.kde.org/r/119745/diff/

Testing
-------

File Attachments
----------------

Generated Output
  https://git.reviewboard.kde.org/media/uploaded/files/2014/08/12/c28277e8-bdd7-4cca-aafb-e36679369dd7__api.png

Thanks,

David Edmundson

--===============0503474373942087332==
MIME-Version: 1.0
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 7bit

<html>
 <body>
  <div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
   <table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 \
solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">  \
<tr>  <td>
      This is an automatically generated e-mail. To reply, visit:
      <a href="https://git.reviewboard.kde.org/r/119745/">https://git.reviewboard.kde.org/r/119745/</a>
  </td>
    </tr>
   </table>
   <br />

<table bgcolor="#e0e0e0" width="100%" cellpadding="12" style="border: 1px gray solid; \
border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">  <tr>
  <td>
   <h1 style="margin: 0; padding: 0; font-size: 10pt;">This change has been marked as \
submitted.</h1>  </td>
 </tr>
</table>
<br />

<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: \
1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; \
-webkit-border-radius: 6px;">  <tr>
  <td>

<div>Review request for KDE Frameworks and Plasma.</div>
<div>By David Edmundson.</div>

<p style="color: grey;"><i>Updated Aug. 12, 2014, 9:15 p.m.</i></p>

<div style="margin-top: 1.5em;">
 <b style="color: #575012; font-size: 10pt;">Repository: </b>
plasma-framework
</div>

<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
 <table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">These classes are exposed only as QML so we should \
only show members the<br style="padding: 0;text-rendering: inherit;margin: \
0;line-height: inherit;white-space: normal;" /> user can actually use.</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">The invokable is moved to the top so we only need one \
block to hide things.</p> <p style="padding: 0;text-rendering: inherit;margin: \
0;line-height: inherit;white-space: inherit;">It's not great having to add tags \
manually, but it's the best I've found; especially as we can't just hide member \
variables as we need Q_INVOKABLES. If this gets approved I'll do the other plasma \
docs.</p></pre>  </td>
 </tr>
</table>

<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">

 <li>src/declarativeimports/core/framesvgitem.h <span style="color: \
grey">(117d10c)</span></li>

</ul>

<p><a href="https://git.reviewboard.kde.org/r/119745/diff/" style="margin-left: \
3em;">View Diff</a></p>

<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">File Attachments \
</h1>

 <li><a href="https://git.reviewboard.kde.org/media/uploaded/files/2014/08/12/c28277e8-bdd7-4cca-aafb-e36679369dd7__api.png">Generated \
Output</a></li>

</ul>

  </td>
 </tr>
</table>

  </div>
 </body>
</html>

--===============0503474373942087332==--

_______________________________________________
Kde-frameworks-devel mailing list
Kde-frameworks-devel@kde.org
https://mail.kde.org/mailman/listinfo/kde-frameworks-devel

[prev in list] [next in list] [prev in thread] [next in thread] 