root/doc/xml/osutils_8h.xml @ 266

Revision 187, 6.7 kB (checked in by smidl, 16 years ago)

doc

Line 
1<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
3  <compounddef id="osutils_8h" kind="file">
4    <compoundname>osutils.h</compoundname>
5    <includes local="no">itpp/itbase.h</includes>
6    <includedby refid="osutils_8cpp" local="yes">work/git/mixpp/bdm/osutils.cpp</includedby>
7    <includedby refid="loggers_8cpp" local="yes">work/git/mixpp/bdm/stat/loggers.cpp</includedby>
8    <incdepgraph>
9      <node id="331">
10        <label>itpp/itbase.h</label>
11      </node>
12      <node id="330">
13        <label>work/git/mixpp/bdm/osutils.h</label>
14        <link refid="osutils.h"/>
15        <childnode refid="331" relation="include">
16        </childnode>
17      </node>
18    </incdepgraph>
19    <innernamespace refid="namespacestd">std</innernamespace>
20      <sectiondef kind="func">
21      <memberdef kind="function" id="osutils_8h_1ec0d016ef7ecdf0aa1ad86b121f50ef9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
22        <type>void</type>
23        <definition>void get_fname</definition>
24        <argsstring>(char *filename, std::string &amp;dirname, std::string &amp;f)</argsstring>
25        <name>get_fname</name>
26        <param>
27          <type>char *</type>
28          <declname>filename</declname>
29        </param>
30        <param>
31          <type>std::string &amp;</type>
32          <declname>dirname</declname>
33        </param>
34        <param>
35          <type>std::string &amp;</type>
36          <declname>f</declname>
37        </param>
38        <briefdescription>
39<para>Function concats name of a directory and file. </para>        </briefdescription>
40        <detaileddescription>
41        </detaileddescription>
42        <inbodydescription>
43        </inbodydescription>
44        <location file="/home/smidl/work/git/mixpp/bdm/osutils.h" line="19"/>
45      </memberdef>
46      <memberdef kind="function" id="osutils_8h_1743784b68da338914e525d9cf074de5f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
47        <type>void</type>
48        <definition>void makedir</definition>
49        <argsstring>(string &amp;dirname, bool rewrite=true)</argsstring>
50        <name>makedir</name>
51        <param>
52          <type>string &amp;</type>
53          <declname>dirname</declname>
54        </param>
55        <param>
56          <type>bool</type>
57          <declname>rewrite</declname>
58          <defval>true</defval>
59        </param>
60        <briefdescription>
61<para>Function creates a directory and raises it_error if it is not possible. </para>        </briefdescription>
62        <detaileddescription>
63<para><parameterlist kind="param"><parameteritem>
64<parameternamelist>
65<parametername>dirname</parametername>
66</parameternamelist>
67<parameterdescription>
68<para>name of the directory to be created </para></parameterdescription>
69</parameteritem>
70<parameteritem>
71<parameternamelist>
72<parametername>rewrite</parametername>
73</parameternamelist>
74<parameterdescription>
75<para>if true then existence of the directory is not an error </para></parameterdescription>
76</parameteritem>
77</parameterlist>
78</para>        </detaileddescription>
79        <inbodydescription>
80        </inbodydescription>
81        <location file="/home/smidl/work/git/mixpp/bdm/osutils.h" line="27" bodyfile="/home/smidl/work/git/mixpp/bdm/osutils.cpp" bodystart="35" bodyend="45"/>
82      </memberdef>
83      </sectiondef>
84    <briefdescription>
85    </briefdescription>
86    <detaileddescription>
87    </detaileddescription>
88    <programlisting>
89<codeline lineno="1"><highlight class="comment">//</highlight><highlight class="normal"></highlight></codeline>
90<codeline lineno="2"><highlight class="normal"></highlight><highlight class="comment">//<sp/>C++<sp/>Interface:<sp/>osutils</highlight><highlight class="normal"></highlight></codeline>
91<codeline lineno="3"><highlight class="normal"></highlight><highlight class="comment">//</highlight><highlight class="normal"></highlight></codeline>
92<codeline lineno="4"><highlight class="normal"></highlight><highlight class="comment">//<sp/>Description:<sp/>Agr</highlight><highlight class="normal"></highlight></codeline>
93<codeline lineno="5"><highlight class="normal"></highlight><highlight class="comment">//</highlight><highlight class="normal"></highlight></codeline>
94<codeline lineno="6"><highlight class="normal"></highlight><highlight class="comment">//</highlight><highlight class="normal"></highlight></codeline>
95<codeline lineno="7"><highlight class="normal"></highlight><highlight class="comment">//<sp/>Author:<sp/>smidl<sp/>&lt;smidl@utia.cas.cz&gt;,<sp/>(C)<sp/>2008</highlight><highlight class="normal"></highlight></codeline>
96<codeline lineno="8"><highlight class="normal"></highlight><highlight class="comment">//</highlight><highlight class="normal"></highlight></codeline>
97<codeline lineno="9"><highlight class="normal"></highlight><highlight class="comment">//<sp/>Copyright:<sp/>See<sp/>COPYING<sp/>file<sp/>that<sp/>comes<sp/>with<sp/>this<sp/>distribution</highlight><highlight class="normal"></highlight></codeline>
98<codeline lineno="10"><highlight class="normal"></highlight><highlight class="comment">//</highlight><highlight class="normal"></highlight></codeline>
99<codeline lineno="11"><highlight class="normal"></highlight><highlight class="comment">//</highlight><highlight class="normal"></highlight></codeline>
100<codeline lineno="12"><highlight class="normal"></highlight></codeline>
101<codeline lineno="13"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;itpp/itbase.h&gt;</highlight><highlight class="normal"></highlight></codeline>
102<codeline lineno="14"><highlight class="normal"></highlight><highlight class="keyword">using<sp/>namespace<sp/></highlight><highlight class="normal">std;</highlight></codeline>
103<codeline lineno="15"><highlight class="normal"></highlight></codeline>
104<codeline lineno="19"><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>get_fname<sp/>(<sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal">*<sp/>filename,<sp/>std::string<sp/>&amp;dirname,<sp/>std::string<sp/>&amp;f<sp/>);</highlight></codeline>
105<codeline lineno="20"><highlight class="normal"></highlight></codeline>
106<codeline lineno="27"><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>makedir(</highlight><highlight class="keywordtype">string</highlight><highlight class="normal"><sp/>&amp;dirname,<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>rewrite<sp/>=<sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">);</highlight></codeline>
107    </programlisting>
108    <location file="/home/smidl/work/git/mixpp/bdm/osutils.h"/>
109  </compounddef>
110</doxygen>
Note: See TracBrowser for help on using the browser.