Skip to content

Commit 7ea9fc4

Browse files
xuhdevxuhdev
committed
Update online html docs.
1 parent a7e18c8 commit 7ea9fc4

35 files changed

Lines changed: 677 additions & 416 deletions

‎core-docs/bc_s.png‎

-28 Bytes
Loading

‎core-docs/doxygen.css‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
body, table, div, p, dl {
44
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
5-
font-size: 12px;
5+
font-size: 13px;
6+
line-height: 1.3;
67
}
78

89
/* @group Heading Levels */
@@ -121,12 +122,12 @@ a.el {
121122
a.elRef {
122123
}
123124

124-
a.code {
125-
color: #4665A2;
125+
a.code, a.code:visited {
126+
color: #4665A2;
126127
}
127128

128-
a.codeRef {
129-
color: #4665A2;
129+
a.codeRef, a.codeRef:visited {
130+
color: #4665A2;
130131
}
131132

132133
/* @end */
@@ -198,6 +199,8 @@ td.indexkey {
198199
border: 1px solid #C4CFE5;
199200
margin: 2px 0px 2px 0;
200201
padding: 2px 10px;
202+
white-space: nowrap;
203+
vertical-align: top;
201204
}
202205

203206
td.indexvalue {

‎core-docs/editorconfig.html‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
56
<title>EditorConfig: EditorConfig Command</title>
67

78
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -44,7 +45,7 @@
4445
</table>
4546
</div>
4647

47-
<!-- Generated by Doxygen 1.7.5.1 -->
48+
<!-- Generated by Doxygen 1.7.6.1 -->
4849
<script type="text/javascript">
4950
var searchBox = new SearchBox("searchBox", "search",false,'Search');
5051
</script>
@@ -88,17 +89,14 @@
8889
<div class="header">
8990
<div class="headertitle">
9091
<div class="title">EditorConfig Command </div> </div>
91-
</div>
92+
</div><!--header-->
9293
<div class="contents">
9394
<div class="textblock"><h2><a class="anchor" id="usage"></a>
9495
Usage of the `editorconfig` command line tool</h2>
9596
<p>Usage: editorconfig <em>[OPTIONS]</em> FILENAME</p>
9697
<pre></pre><pre> <em>-f</em> Sepcify a conf file name other than the default value
9798
".editorconfig".</pre><pre> <em>-b</em> Sepcify a version to act like. Usually used for
98-
testing compatibility for editor plugin developers.</pre><pre> <em>-h</em> OR <em>--help</em> Print this help message.</pre><pre> <em>--version</em> Display version information.</pre><pre> </pre> </div></div>
99-
</div>
100-
<div id="nav-path" class="navpath">
101-
<ul>
99+
testing compatibility for editor plugin developers.</pre><pre> <em>-h</em> OR <em>--help</em> Print this help message.</pre><pre> <em>--version</em> Display version information.</pre><pre> </pre> </div></div><!-- contents -->
102100
<!-- window showing the filter options -->
103101
<div id="MSearchSelectWindow"
104102
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -113,10 +111,13 @@
113111
</iframe>
114112
</div>
115113

114+
</div>
115+
<div id="nav-path" class="navpath">
116+
<ul>
116117

117-
<li class="footer">Generated on Fri Dec 16 2011 12:21:09 for EditorConfig by
118+
<li class="footer">Generated on Thu Jan 5 2012 20:19:48 for EditorConfig by
118119
<a href="http://www.doxygen.org/index.html">
119-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
120+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
120121
</ul>
121122
</div>
122123

‎core-docs/editorconfig_8h.html‎

Lines changed: 48 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
56
<title>EditorConfig: editorconfig.h File Reference</title>
67

78
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -44,7 +45,7 @@
4445
</table>
4546
</div>
4647

47-
<!-- Generated by Doxygen 1.7.5.1 -->
48+
<!-- Generated by Doxygen 1.7.6.1 -->
4849
<script type="text/javascript">
4950
var searchBox = new SearchBox("searchBox", "search",false,'Search');
5051
</script>
@@ -97,7 +98,7 @@
9798
<a href="#func-members">Functions</a> </div>
9899
<div class="headertitle">
99100
<div class="title">editorconfig.h File Reference</div> </div>
100-
</div>
101+
</div><!--header-->
101102
<div class="contents">
102103

103104
<p>Header file of EditorConfig.
@@ -115,6 +116,8 @@
115116
Functions</h2></td></tr>
116117
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92">editorconfig_parse</a> (const char *full_filename, <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> h)</td></tr>
117118
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse editorconfig files corresponding to the file path given by full_filename, and related information is input and output in h. <a href="#add6bebe96bf90c48fef01cf5300ddf92"></a><br/></td></tr>
119+
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#a779a54d57d57198a089ea7221751330c">editorconfig_get_error_msg</a> (int err_num)</td></tr>
120+
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error message from the error number returned by <a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a>. <a href="#a779a54d57d57198a089ea7221751330c"></a><br/></td></tr>
118121
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="editorconfig_8h.html#a388429db79c58c67f166a7daa026e695">editorconfig_get_version</a> (int *major, int *minor, int *subminor)</td></tr>
119122
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of EditorConfig. <a href="#a388429db79c58c67f166a7daa026e695"></a><br/></td></tr>
120123
</table>
@@ -127,7 +130,7 @@
127130
<div class="memproto">
128131
<table class="memname">
129132
<tr>
130-
<td class="memname">#define EDITORCONFIG_PARSE_MEMORY_ERROR&#160;&#160;&#160;(-3)</td>
133+
<td class="memname">#define <a class="el" href="editorconfig_8h.html#a492500afec561a16fc6e8e23b261abaf">EDITORCONFIG_PARSE_MEMORY_ERROR</a>&#160;&#160;&#160;(-3)</td>
131134
</tr>
132135
</table>
133136
</div>
@@ -141,7 +144,7 @@
141144
<div class="memproto">
142145
<table class="memname">
143146
<tr>
144-
<td class="memname">#define EDITORCONFIG_PARSE_NOT_FULL_PATH&#160;&#160;&#160;(-2)</td>
147+
<td class="memname">#define <a class="el" href="editorconfig_8h.html#a7a8131a3c229adb8eba19262e981b0f7">EDITORCONFIG_PARSE_NOT_FULL_PATH</a>&#160;&#160;&#160;(-2)</td>
145148
</tr>
146149
</table>
147150
</div>
@@ -155,7 +158,7 @@
155158
<div class="memproto">
156159
<table class="memname">
157160
<tr>
158-
<td class="memname">#define EDITORCONFIG_PARSE_VERSION_TOO_NEW&#160;&#160;&#160;(-4)</td>
161+
<td class="memname">#define <a class="el" href="editorconfig_8h.html#afe623becaffb01263d1b22bd320f7916">EDITORCONFIG_PARSE_VERSION_TOO_NEW</a>&#160;&#160;&#160;(-4)</td>
159162
</tr>
160163
</table>
161164
</div>
@@ -165,12 +168,39 @@
165168
</div>
166169
</div>
167170
<hr/><h2>Function Documentation</h2>
171+
<a class="anchor" id="a779a54d57d57198a089ea7221751330c"></a><!-- doxytag: member="editorconfig.h::editorconfig_get_error_msg" ref="a779a54d57d57198a089ea7221751330c" args="(int err_num)" -->
172+
<div class="memitem">
173+
<div class="memproto">
174+
<table class="memname">
175+
<tr>
176+
<td class="memname">const char* <a class="el" href="editorconfig_8h.html#a779a54d57d57198a089ea7221751330c">editorconfig_get_error_msg</a> </td>
177+
<td>(</td>
178+
<td class="paramtype">int&#160;</td>
179+
<td class="paramname"><em>err_num</em></td><td>)</td>
180+
<td></td>
181+
</tr>
182+
</table>
183+
</div>
184+
<div class="memdoc">
185+
186+
<p>Get the error message from the error number returned by <a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92" title="Parse editorconfig files corresponding to the file path given by full_filename, and related informati...">editorconfig_parse()</a>. </p>
187+
<p>An example is available at src/bin/main.c in editorconfig source code.</p>
188+
<dl class="params"><dt><b>Parameters:</b></dt><dd>
189+
<table class="params">
190+
<tr><td class="paramname">err_num</td><td>The error number that is used to obtain the error message.</td></tr>
191+
</table>
192+
</dd>
193+
</dl>
194+
<dl class="return"><dt><b>Returns:</b></dt><dd>The error message corresponding to err_num. </dd></dl>
195+
196+
</div>
197+
</div>
168198
<a class="anchor" id="a388429db79c58c67f166a7daa026e695"></a><!-- doxytag: member="editorconfig.h::editorconfig_get_version" ref="a388429db79c58c67f166a7daa026e695" args="(int *major, int *minor, int *subminor)" -->
169199
<div class="memitem">
170200
<div class="memproto">
171201
<table class="memname">
172202
<tr>
173-
<td class="memname">void editorconfig_get_version </td>
203+
<td class="memname">void <a class="el" href="editorconfig_8h.html#a388429db79c58c67f166a7daa026e695">editorconfig_get_version</a> </td>
174204
<td>(</td>
175205
<td class="paramtype">int *&#160;</td>
176206
<td class="paramname"><em>major</em>, </td>
@@ -198,7 +228,7 @@
198228

199229
<p>Get the version number of EditorConfig. </p>
200230
<p>An example is available at src/bin/main.c in EditorConfig source code.</p>
201-
<dl><dt><b>Parameters:</b></dt><dd>
231+
<dl class="params"><dt><b>Parameters:</b></dt><dd>
202232
<table class="params">
203233
<tr><td class="paramname">major</td><td>If not null, the integer pointed by major will be filled with the major version of EditorConfig.</td></tr>
204234
<tr><td class="paramname">minor</td><td>If not null, the integer pointed by minor will be filled with the minor version of EditorConfig.</td></tr>
@@ -215,7 +245,7 @@
215245
<div class="memproto">
216246
<table class="memname">
217247
<tr>
218-
<td class="memname">int editorconfig_parse </td>
248+
<td class="memname">int <a class="el" href="editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92">editorconfig_parse</a> </td>
219249
<td>(</td>
220250
<td class="paramtype">const char *&#160;</td>
221251
<td class="paramname"><em>full_filename</em>, </td>
@@ -237,32 +267,29 @@
237267

238268
<p>Parse editorconfig files corresponding to the file path given by full_filename, and related information is input and output in h. </p>
239269
<p>An example is available at src/bin/main.c in editorconfig source code.</p>
240-
<dl><dt><b>Parameters:</b></dt><dd>
270+
<dl class="params"><dt><b>Parameters:</b></dt><dd>
241271
<table class="params">
242272
<tr><td class="paramname">full_filename</td><td>The full path of a file that is edited by the editor for which the parsing result is.</td></tr>
243-
<tr><td class="paramname">h</td><td>The editorconfig_handle to be used and returned from this function (including the parsing result). The editorconfig_handle should be created by <a class="el" href="editorconfig__handle_8h.html#a8e3f1681e835a2946ba93b341ebc3dca" title="Create and intialize a default editorconfig_handle object.">editorconfig_handle_init()</a>.</td></tr>
273+
<tr><td class="paramname">h</td><td>The <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> to be used and returned from this function (including the parsing result). The <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> should be created by <a class="el" href="editorconfig__handle_8h.html#a8e3f1681e835a2946ba93b341ebc3dca" title="Create and intialize a default editorconfig_handle object.">editorconfig_handle_init()</a>.</td></tr>
244274
</table>
245275
</dd>
246276
</dl>
247-
<dl><dt><b>Return values:</b></dt><dd>
277+
<dl class="retval"><dt><b>Return values:</b></dt><dd>
248278
<table class="retval">
249279
<tr><td class="paramname">0</td><td>Everything is OK.</td></tr>
250280
<tr><td class="paramname">Positive Integer</td><td>A parsing error occurs. The return value would be the line number of parsing error. err_file obtained from h by calling <a class="el" href="editorconfig__handle_8h.html#ae0c5207a1986dfea2f641008ddefdd93" title="Get the err_file field of an editorconfig_handle object.">editorconfig_handle_get_err_file()</a> will also be filled with the file path that caused the parsing error.</td></tr>
251281
<tr><td class="paramname">Negative Integer</td><td>Some error occured. See below for the reason of the error for each return value.</td></tr>
252282
<tr><td class="paramname">EDITORCONFIG_PARSE_NOT_FULL_PATH</td><td>The full_filename is not a full path name.</td></tr>
253283
<tr><td class="paramname">EDITORCONFIG_PARSE_MEMORY_ERROR</td><td>A memory error occurs.</td></tr>
254-
<tr><td class="paramname">EDITORCONFIG_PARSE_VERSION_TOO_NEW</td><td>The required version specified in editorconfig_handle is greater than the current version. </td></tr>
284+
<tr><td class="paramname">EDITORCONFIG_PARSE_VERSION_TOO_NEW</td><td>The required version specified in <a class="el" href="editorconfig__handle_8h.html#a0c51d798e0e22051d0057a567245010c">editorconfig_handle</a> is greater than the current version. </td></tr>
255285
</table>
256286
</dd>
257287
</dl>
258288

259289
</div>
260290
</div>
291+
</div><!-- contents -->
261292
</div>
262-
</div>
263-
<div id="nav-path" class="navpath">
264-
<ul>
265-
<li class="navelem"><a class="el" href="editorconfig_8h.html">editorconfig.h</a> </li>
266293
<!-- window showing the filter options -->
267294
<div id="MSearchSelectWindow"
268295
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -277,10 +304,13 @@
277304
</iframe>
278305
</div>
279306

307+
<div id="nav-path" class="navpath">
308+
<ul>
309+
<li class="navelem"><a class="el" href="editorconfig_8h.html">editorconfig.h</a> </li>
280310

281-
<li class="footer">Generated on Fri Dec 16 2011 12:21:09 for EditorConfig by
311+
<li class="footer">Generated on Thu Jan 5 2012 20:19:48 for EditorConfig by
282312
<a href="http://www.doxygen.org/index.html">
283-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
313+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
284314
</ul>
285315
</div>
286316

‎core-docs/editorconfig_8h.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
var editorconfig_8h =
2+
[
3+
[ "EDITORCONFIG_PARSE_MEMORY_ERROR", "editorconfig_8h.html#a492500afec561a16fc6e8e23b261abaf", null ],
4+
[ "EDITORCONFIG_PARSE_NOT_FULL_PATH", "editorconfig_8h.html#a7a8131a3c229adb8eba19262e981b0f7", null ],
5+
[ "EDITORCONFIG_PARSE_VERSION_TOO_NEW", "editorconfig_8h.html#afe623becaffb01263d1b22bd320f7916", null ],
6+
[ "editorconfig_get_error_msg", "editorconfig_8h.html#a779a54d57d57198a089ea7221751330c", null ],
7+
[ "editorconfig_get_version", "editorconfig_8h.html#a388429db79c58c67f166a7daa026e695", null ],
8+
[ "editorconfig_parse", "editorconfig_8h.html#add6bebe96bf90c48fef01cf5300ddf92", null ]
9+
];

0 commit comments

Comments
 (0)