/usr/share/doc/libwreport-doc/apidocs/style.html is in libwreport-doc 3.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>libwreport: Coding style</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libwreport
 <span id="projectnumber">3.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Coding style </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Everything in wreport/*.h is considered public API, but everything in subdirectories should be considered private implementation details.</p>
<p>No headers in wreport/*.h can include headers in subdirectories. <a class="el" href="tests_8h_source.html">wreport/tests.h</a> is the only exception, to include the test framework from <a class="el" href="utils_2tests_8h_source.html">utils/tests.h</a></p>
<p>The public API is supposed to be API and ABI stable. Implementation details are removed as much as possible from headers to make this easier.</p>
<p>Unit tests are collected in files *-test.cc which generally correspond to the module they are testing. The unit testing framework is contained inside wreport, and comes from <a href="https://github.com/spanezz/wobble">https://github.com/spanezz/wobble</a></p>
<p>Documentation is automatically generated by doxygen.</p>
<p>C++ use tries to follow a "Do Not Call Up That Which You Cannot Put Down" rule of avoiding to use language features and abstraction layers unless they are really needed or make code significantly simpler.</p>
<p>Errors are reported through exceptions (see <a class="el" href="error_8h.html" title="wreport exceptions. ">error.h</a>). <a href="http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization">RAII</a> is used (see for example <a class="el" href="structwreport_1_1notes_1_1Collect.html" title="RAII way to temporarily set a notes target. ">wreport::notes::Collect</a>) to simplify programming and ensure proper resource handling also in case of errors.</p>
<p>Memory management responsibilities are made obvious by the use of:</p><ul>
<li>references and const pointers, which implicitly deny pointer ownership transfer;</li>
<li>std::unique_ptr to explictly mark ownership transfer (see <a class="el" href="classwreport_1_1Var.html#a66dc1f422b2cd73b450de93f2409f581" title="Set an attribute of the variable. ">wreport::Var::seta()</a>);</li>
<li>documentation for all other cases.</li>
</ul>
<p>Dependencies are kept to a bare minimum for ease of deploying.</p>
<p>The code is migrating from tab-indent to 4-spaces indent. To preserve useful diffs across VCS version, old code has not been reformatted, and gets reformatted only as code is otherwise modified. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 18 2016 13:32:18 for libwreport by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|