Skip to content

Commit e952c4c

Browse files
author
Jens K. Mueller
committed
Add documentation with bootDoc
1 parent b42adfd commit e952c4c

File tree

4 files changed

+255
-8
lines changed

4 files changed

+255
-8
lines changed

‎docs/bootdoc.ddoc‎

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
MODULE = <li class="sidebar-list-entry tree-leaf"><a href="$1.html" title="$1"><i class="icon-th"></i>$1</a></li>
2+
WARNING = <div><strong>Warning:</strong> $0</div>
3+
CRITICAL = <div><strong>Critical:</strong> $0</div>
4+
5+
DDOC = <!DOCTYPE html>
6+
<html lang="en">
7+
<head>
8+
<meta charset="utf-8">
9+
<title>$(TITLE) - $(PROJECTNAME) documentation</title>
10+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
11+
<meta name="description" content="">
12+
<meta name="author" content="">
13+
14+
<!-- styles -->
15+
<link href="$(RESOURCEROOT)css/bootstrap.css" rel="stylesheet">
16+
<style type="text/css">
17+
body {
18+
padding-top: 60px;
19+
padding-bottom: 40px;
20+
}
21+
.sidebar-nav {
22+
padding: 9px 0;
23+
}
24+
</style>
25+
<link href="$(RESOURCEROOT)css/bootstrap-responsive.css" rel="stylesheet">
26+
<link href="$(RESOURCEROOT)bootdoc.css" rel="stylesheet">
27+
28+
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
29+
<!--[if lt IE 9]>
30+
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
31+
<![endif]-->
32+
33+
<!-- fav and touch icons -->
34+
<link rel="shortcut icon" href="$(FAVICON)">
35+
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="$(RESOURCEROOT)ico/apple-touch-icon-114-precomposed.png">
36+
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="$(RESOURCEROOT)ico/apple-touch-icon-72-precomposed.png">
37+
<link rel="apple-touch-icon-precomposed" href="$(RESOURCEROOT)ico/apple-touch-icon-57-precomposed.png">
38+
39+
<!-- Introduce DDoc settings required by JavaScript -->
40+
<script type="text/javascript">
41+
var Title = '$(TITLE)';
42+
var SourceRepository = '$(REPOSRCTREE)';
43+
var PackageSeparator = '$(PACKAGESEP)';
44+
</script>
45+
46+
<style type="text/css">
47+
.ddoc-icon-variable { background-image: url('$(RESOURCEROOT)ddoc-icons/var.png'); }
48+
.ddoc-icon-function { background-image: url('$(RESOURCEROOT)ddoc-icons/func.png'); }
49+
.ddoc-icon-property { background-image: url('$(RESOURCEROOT)ddoc-icons/property.png'); }
50+
.ddoc-icon-struct { background-image: url('$(RESOURCEROOT)ddoc-icons/struct.png'); }
51+
.ddoc-icon-class { background-image: url('$(RESOURCEROOT)ddoc-icons/class.png'); }
52+
.ddoc-icon-enum { background-image: url('$(RESOURCEROOT)ddoc-icons/enum.png'); }
53+
.ddoc-icon-template { background-image: url('$(RESOURCEROOT)ddoc-icons/template.png'); }
54+
</style>
55+
</head>
56+
57+
<body>
58+
<!--
59+
JavaScript reaps the module list from this element.
60+
This is required for the MODULES macro to be reusable
61+
in a noscript element later.
62+
-->
63+
<ul id="module-list-source" class="hidden">
64+
$(MODULES)
65+
</ul>
66+
67+
<div class="navbar navbar-fixed-top">
68+
<div class="navbar-inner">
69+
<div class="container-fluid">
70+
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
71+
<span class="icon-bar"></span>
72+
<span class="icon-bar"></span>
73+
<span class="icon-bar"></span>
74+
</a>
75+
<a class="brand" href="$(REFERENCETOP)">$(PROJECTNAME)</a>
76+
<div class="nav-collapse">
77+
<ul class="nav">
78+
<li class="active"><a href="$(REFERENCETOP)">Reference</a></li>
79+
</ul>
80+
81+
<form id="gotosymbol" class="navbar-search pull-left hidden">
82+
<input type="text" class="search-query" placeholder="Go to symbol in $(TITLE)" data-provide="typeahead" data-items="4">
83+
</form>
84+
85+
<p class="navbar-text pull-right">$(TITLEBARTEXT)</p>
86+
</div><!--/.nav-collapse -->
87+
</div>
88+
</div>
89+
</div>
90+
91+
<div class="container-fluid">
92+
<div class="row-fluid">
93+
<div class="span2">
94+
<div class="well sidebar-nav">
95+
<ul class="nav nav-list">
96+
<li id="module-list" class="nav-header sidebar-list-entry">Modules<li>
97+
<noscript>
98+
$(MODULES)
99+
</noscript>
100+
<li id="symbol-list" class="nav-header sidebar-list-entry hidden">$(TITLE)</li>
101+
</ul>
102+
</div><!--/.well -->
103+
</div><!--/span-->
104+
105+
<div class="span10">
106+
<div class="row-fluid">
107+
<div class="span11">
108+
<ul id="module-breadcrumb" class="breadcrumb">
109+
<noscript><h1>$(TITLE)</h1></noscript>
110+
</ul>
111+
112+
</div>
113+
<!--
114+
<div class="span1 offset11">
115+
<a href="$(LOGOLINK)"><img src="$(LOGOSRC)" alt="$(LOGOALT)"/></a>
116+
</div>
117+
-->
118+
</div>
119+
<div id="declaration-list">
120+
$(BODY)
121+
</div>
122+
123+
<hr>
124+
125+
<footer class="pull-left">
126+
<p>Page generated with <a href="https://github.com/JakobOvrum/bootDoc">bootDoc</a>.</p>
127+
</footer>
128+
129+
<footer class="pull-right">
130+
<p>$(COPYRIGHTFOOTER)</p>
131+
</footer>
132+
</div>
133+
</div>
134+
</div><!--/.fluid-container-->
135+
136+
<!-- Bootstrap javascript
137+
================================================== -->
138+
<!-- Placed at the end of the document so the pages load faster -->
139+
<script src="$(RESOURCEROOT)js/jquery.min.js"></script>
140+
<script src="$(RESOURCEROOT)js/bootstrap.min.js"></script>
141+
142+
<!-- bootDoc javascript
143+
================================================== -->
144+
<script src="$(RESOURCEROOT)bootdoc.js"></script>
145+
146+
</body>
147+
</html>
148+
149+
DDOC_DECL = <hr><div class="row-fluid declaration"><h3>$0</h3></div>
150+
DDOC_DECL_DD = <div class="declaration-content">$0</div>
151+
DDOC_PSYMBOL = <a class="symbol symbol-anchor" name="$0" href="#$0">$0</a>
152+
DDOC_SYMBOL = <s>$0</s>
153+
DDOC_SUMMARY = <p>$0</p>
154+
155+
DDOC_SECTIONS = <dl>$0</dl>
156+
SECTION = <dt>$1</dt><dd>$2</dd>
157+
DDOC_SECTION_H = <dt>$0</dt><dd>
158+
DDOC_SECTION = $0</dd>
159+
DDOC_DESCRIPTION = <p>$0</p>
160+
DDOC_BUGS = $(SECTION Known Bugs, $0)
161+
DDOC_COPYRIGHT = $(SECTION Copyright, $0)
162+
DDOC_AUTHORS = $(SECTION Authors, $0)
163+
DDOC_DATE = $(SECTION Date, $0)
164+
DDOC_DEPRECATED = $(SECTION Deprecated, $0)
165+
DDOC_EXAMPLES = $(SECTION Examples, $0)
166+
DDOC_EXAMPLE = $(SECTION Examples, $0)
167+
DDOC_HISTORY = $(SECTION History, $0)
168+
DDOC_LICENSE = $(SECTION License, $0)
169+
DDOC_RETURNS = $(SECTION Returns, $0)
170+
DDOC_SEE_ALSO = $(SECTION See Also, $0)
171+
DDOC_STANDARDS = $(SECTION Standards, $0)
172+
DDOC_THROWS = $(SECTION Throws, $0)
173+
DDOC_VERSION = $(SECTION Version, $0)
174+
175+
DDOC_MEMBERS = $0
176+
OFFSETMEMBERS = <div class="offset1 member-list">$0</div>
177+
DDOC_STRUCT_MEMBERS = $(OFFSETMEMBERS $0)
178+
DDOC_CLASS_MEMBERS= $(OFFSETMEMBERS $0)
179+
DDOC_TEMPLATE_MEMBERS = $(OFFSETMEMBERS $0)
180+
DDOC_ENUM_MEMBERS = $(OFFSETMEMBERS $0)
181+
182+
DDOC_PARAMS = $(SECTION Parameters, <table class="table table-condensed table-bordered">$0</table>)
183+
DDOC_PARAM_ROW = <tr>$0</tr>
184+
DDOC_PARAM_ID = <td>$0</td>
185+
DDOC_PARAM_DESC = <td>$0</td>
186+
187+
DDOC_KEYWORD = <span class="d_keyword">$0</span>
188+
D_KEYWORD = $(DDOC_KEYWORD $0)
189+
D_STRING = <span class="d_string">$0</span>
190+
D_PARAM = $(B $0)
191+
D_COMMENT = <span class="d_comment">$0</span>
192+
193+
RPAREN = )
194+
LPAREN = (
195+
LESS = &lt;
196+
GREATER = &gt;
197+
WEB = $(LINK2 http://$1,$2)
198+
LUCKY = $(WEB
199+
google.com/search?btnI=I%27m+Feeling+Lucky&amp;ie=UTF-8&amp;oe=UTF-8&amp;q=$0,$0)
200+
D = <span class="inlinecode">$0</span>
201+
BIGOH = <b><i>&Omicron;</i>(</b>$(D $0)<b><i>)</i></b>
202+
GLOSSARY = $(LINK2 ../glossary.html#$0, $0)
203+
XREF = <a href="std_$1.html#$2">$(D std.$1.$2)</a>
204+
CXREF = <a href="core_$1.html#$2">$(D core.$1.$2)</a>
205+
ECXREF = <a href="etc_c_$1.html#$2">$(D etc.c.$1.$2)</a>
206+
LREF = <a href="#$1">$(D $1)</a>
207+
BUGZILLA = $(LINK2 http://d.puremagic.com/issues/show_bug.cgi?id=$0, Bugzilla $0)
208+
PRE = <pre>$0</pre>
209+
PHOBOSSRC=$(LINK2 https://github.com/D-Programming-Language/phobos/blob/master/$0, $0)
210+
DRUNTIMESRC=$(LINK2 https://github.com/D-Programming-Language/druntime/blob/master/src/$0, $0)
211+
SAMPLESRC=$(LINK2 https://github.com/D-Programming-Language/dmd/blob/master/samples/$0, /dmd/samples/d/$0)
212+
213+
BOOKTABLE = <table cellspacing=0 cellpadding=5 class="table"><caption>$1</caption>$2</table>
214+
LEADINGROW = <tr class=leadingrow><td colspan=2><b><em>&nbsp;&nbsp;&nbsp;&nbsp;$0</em></b></td></tr>
215+
TABLE = <table cellspacing=0 cellpadding=5><caption>$1</caption>$2</table>
216+
TD = <td valign=top>$0</td>
217+
TDNW = <td valign=top class="donthyphenate">$0</td>
218+
SUB = <sub>$0</sub>
219+
220+
COLOR = <span style="color:$1">$2</span>
221+
222+
TABLE_SV = <table style="border:1px solid silver;">$0</table>

‎docs/modules.ddoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
MODULES =
2+
$(MODULE ddl)

‎docs/settings.ddoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
PROJECTNAME = ddl
2+
REPOSITORY_URL = http://github.com/jkm/$(PROJECTNAME)
3+
REPOSRCTREE = $(REPOSITORY_URL)/blob/master/src
4+
REFERENCETOP = $(PROJECTNAME).html
5+
TITLEBARTEXT = <a href="http://buildhive.sdf.com/$(PROJECTNAME)">continuously integrated @ buildhive</a>
6+
RESOURCEROOT =
7+
PACKAGESEP = .
8+
FAVICON = $(RESOURCEROOT)ico/favicon.ico
9+
LOGOSRC = $(RESOURCEROOT)img/icon-github.png
10+
LOGOALT = $(PROJECTNAME)
11+
LOGOLINK = $(REFERENCETOP)
12+
COPYRIGHT = Jens K. Mueller
13+
COPYRIGHTFOOTER = &copy; $(COPYRIGHT) 2012-$(YEAR) (generated at $(DATETIME))
14+
15+
ISSUES = $(LINK $(REPOSITORY_URL)/issues)
16+
LICENSE = $(LINK_TEXT http://www.boost.org/LICENSE_1_0.txt, Boost License 1.0)
17+
VERSION = 0.1
18+
DATE = 2012-03-21
19+
20+
LINK = <a href="$0">$0</a>
21+
LINK_TEXT = <a href="$1">$+</a>
22+
PHOBOS_MODULE_LINK = $(LINK_TEXT http://dlang.org/phobos/$1#$2, $2)
23+
ANCHOR = <a name="$1">$+</a>
24+
LOCAL_LINK = <a href="#$0">$0</a>
25+
LOCAL_LINK_TEXT = <a href="#$1">$+</a>

‎src/ddl.d‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@
2323
* only compiled and tested on Linux. Please report any issue while trying it
2424
* out.)
2525
*
26-
* Source: $(SOURCE)
2726
* Bugs: $(ISSUES)
2827
* License: $(LICENSE)
2928
* Version: $(VERSION) ($(B alpha release))
30-
* Date: 2012-03-16
31-
*
29+
* Date: $(DATE)
30+
* $(BR)
31+
* $(BR)
32+
* $(BR)
3233
* Examples:
33-
* $(B Synopsis)
3434
*
3535
* The canonical Hello World loading the C library at run time and calling its
3636
* printf function.
@@ -450,8 +450,8 @@ unittest
450450

451451
/**
452452
* $(ANCHOR loadLibraryWithName)
453-
* Returns: a $(LOCAL_LINK Library)!moduleName loading library libraryName and
454-
* all extern(C) functions declared in module moduleName bu default.
453+
* Returns: a $(LOCAL_LINK_TEXT Library, Library!moduleName) loading library libraryName and
454+
* all extern(C) functions declared in module moduleName by default.
455455
*
456456
* Params:
457457
* moduleName = is the module name those extern(C) functions will be loaded
@@ -479,7 +479,6 @@ unittest
479479
* inferred from the module name.
480480
*
481481
* Examples:
482-
* $(B Example:)
483482
* ---
484483
* import ZeroMQ.zmq;
485484
* auto zmq = loadLibrary!(ZeroMQ.zmq); // loads library with name "zmq"
@@ -507,7 +506,6 @@ unittest
507506
* as = is the variable name used when declaring Library!(moduleName)
508507
*
509508
* Examples:
510-
* $(B Example:)
511509
* ---
512510
* mixin declareLibraryAndAlias!("ZeroMQ.zmq", "zmq");
513511
* ---

0 commit comments

Comments
 (0)