'Doxygen: Snippets examples'

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

List:       kde-devel
Subject:    Doxygen: Snippets examples
From:       Olivier Churlaud <olivier () churlaud ! com>
Date:       2016-06-15 21:28:05
Message-ID: 1a65e0c7-d69a-8bb4-cf97-c8c38a5f3017 () churlaud ! com
[Download RAW message or body]

Hi,

I was speaking with the plasma people the other day and they told that 
missed a way to keep tutorials and examples in the documentation up to 
date. Since they didn't know that, I guess it can be useful for others.

I updated the corresponding page [1]. With the  \snippet command, you 
can refer to code which is in compilable examples (normally in /example).

This allow every API to be nicely documented, and to provide 
step-by-step*tutorials*! And the awesome part is that these tutorial 
will stay *up-to-date*!


That's all,

Olivier

[1] 
https://community.kde.org/Guidelines_and_HOWTOs/API_Documentation#Code_Examples_in_APIDOX

-- 
Olivier CHURLAUD
Engineer Student at Ecole Centrale de Lyon
in Dual Degree at TU Berlin, M.Sc. Elektrotechnik
@: olivier@churlaud.com
tel: +49 (0)1575-2931348
in:  http://linkedin.com/in/olivierchurlaud
web: http://olivier.churlaud.com


[Attachment #3 (text/html)]

<html>
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
  </head>
  <body bgcolor="#FFFFFF" text="#000000">
    <p>Hi,</p>
    <p>I was speaking with the plasma people the other day and they told
      that missed a way to keep tutorials and examples in the
      documentation up to date. Since they didn't know that, I guess it
      can be useful for others.<br>
    </p>
    <p>I updated the corresponding page [1]. With the   \snippet command,
      you can refer to code which is in compilable examples (normally in
      /example). <br>
    </p>
    <p>This allow every API to be nicely documented, and to provide
      step-by-step<b> tutorials</b>! And the awesome part is that these
      tutorial will stay <b>up-to-date</b>!</p>
    <p><br>
    </p>
    <p>That's all,</p>
    <p>Olivier<br>
    </p>
    <p>[1]
<a class="moz-txt-link-freetext" \
href="https://community.kde.org/Guidelines_and_HOWTOs/API_Documentation#Code_Examples_ \
in_APIDOX">https://community.kde.org/Guidelines_and_HOWTOs/API_Documentation#Code_Examples_in_APIDOX</a></p>
  <pre class="moz-signature" cols="72">-- 
Olivier CHURLAUD
Engineer Student at Ecole Centrale de Lyon
in Dual Degree at TU Berlin, M.Sc. Elektrotechnik
@: <a class="moz-txt-link-abbreviated" \
                href="mailto:olivier@churlaud.com">olivier@churlaud.com</a>
tel: +49 (0)1575-2931348
in:  <a class="moz-txt-link-freetext" \
href="http://linkedin.com/in/olivierchurlaud">http://linkedin.com/in/olivierchurlaud</a>
                
web: <a class="moz-txt-link-freetext" \
href="http://olivier.churlaud.com">http://olivier.churlaud.com</a> </pre>  </body>
</html>



[prev in list] [next in list] [prev in thread] [next in thread]
Configure | About | News | Add a list | Sponsored by KoreLogic