Skip to content

Commit e9c36b5

Browse files
lucassouzavieiralucassouzavieira
committed
chore[documentation]: update existing docs
1 parent 5ab03ce commit e9c36b5

File tree

12 files changed

+57
-4071
lines changed

12 files changed

+57
-4071
lines changed

‎docs/css/base.css‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
--color-hue-brown: 16;
4242

4343
/* Colors */
44-
--primary-color-hue: var(--color-hue-red, --color-hue-phpdocumentor-green);
44+
--primary-color-hue: var(--color-hue-phpdocumentor-green, --color-hue-phpdocumentor-green);
4545
--primary-color-saturation: 57%;
4646
--primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%);
4747
--primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%);
@@ -99,6 +99,7 @@
9999
/* Base Styles
100100
-------------------------------------------------- */
101101
body {
102+
background-color: #fff;
102103
color: var(--text-color);
103104
font-family: var(--font-primary);
104105
font-size: var(--text-md);
@@ -494,7 +495,7 @@ div.phpdocumentor-list > ul,
494495
ol.phpdocumentor-list,
495496
ul.phpdocumentor-list {
496497
margin-top: 0;
497-
padding-left: var(--spacing-md);
498+
padding-left: var(--spacing-lg);
498499
margin-bottom: var(--spacing-sm);
499500
}
500501

@@ -1215,6 +1216,10 @@ is too big a fix and needs to be done in a new design iteration.
12151216
word-break: break-all;
12161217
line-height: normal;
12171218
}
1219+
1220+
.phpdocumentor-on-this-page__content li.-deprecated {
1221+
text-decoration: line-through;
1222+
}
12181223
}
12191224

12201225
/* Used for screen readers and such */

‎docs/css/template.css‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@
100100
display: block;
101101
font-size: var(--text-sm);
102102
border: 1px solid #f0f0f0;
103+
margin-bottom: calc(var(--spacing-sm));
103104
}
104105

105106
.phpdocumentor .phpdocumentor-signature.-deprecated .phpdocumentor-signature__name {
@@ -126,6 +127,10 @@
126127
flex: 0 1 auto;
127128
}
128129

130+
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a.-deprecated {
131+
text-decoration: line-through;
132+
}
133+
129134
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span {
130135
flex: 1;
131136
white-space: nowrap;
@@ -152,7 +157,7 @@
152157
width: 1.25rem;
153158
height: 1.25rem;
154159
line-height: 1.25rem;
155-
background: transparent url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl( 4, 57%, 60%)"/></svg>') no-repeat center center;
160+
background: transparent url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl( 96, 57%, 60%)"/></svg>') no-repeat center center;
156161
content: '';
157162
position: absolute;
158163
left: 0;
@@ -167,13 +172,13 @@
167172
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before {
168173
content: 'M';
169174
color: '';
170-
background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl( 4, 57%, 60%)"/></svg>');
175+
background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl( 96, 57%, 60%)"/></svg>');
171176
}
172177

173178
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before {
174179
content: 'M';
175-
color: ' 4';
176-
background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl( 4, 57%, 60%)"/></svg>');
180+
color: ' 96';
181+
background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl( 96, 57%, 60%)"/></svg>');
177182
}
178183

179184
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before {
@@ -183,7 +188,7 @@
183188
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before {
184189
content: 'C';
185190
background-color: transparent;
186-
background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="-3.05176e-05" y="9.99998" width="14.1422" height="14.1422" transform="rotate(-45 -3.05176e-05 9.99998)" fill="hsl( 4, 57%, 60%)"/></svg>');
191+
background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="-3.05176e-05" y="9.99998" width="14.1422" height="14.1422" transform="rotate(-45 -3.05176e-05 9.99998)" fill="hsl( 96, 57%, 60%)"/></svg>');
187192
}
188193

189194
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before {
@@ -269,3 +274,6 @@
269274
.phpdocumentor-tag-link {
270275
margin-right: var(--spacing-sm);
271276
}
277+
.phpdocumentor-uml-diagram svg {
278+
cursor: zoom-in;
279+
}

‎docs/graphs/classes.html‎

Lines changed: 2 additions & 164 deletions
Original file line numberDiff line numberDiff line change
@@ -42,177 +42,15 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Ara
4242
Menu
4343
</label>
4444
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
45-
<section class="phpdocumentor-sidebar__category">
46-
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
47-
<h4 class="phpdocumentor-sidebar__root-namespace">
48-
<a href="namespaces/arangodb.html" class="">ArangoDB</a>
49-
</h4>
50-
<ul class="phpdocumentor-list">
51-
<li>
52-
<a href="namespaces/arangodb-admin.html" class="">Admin</a>
5345

54-
</li>
55-
<li>
56-
<a href="namespaces/arangodb-aql.html" class="">AQL</a>
57-
58-
</li>
59-
<li>
60-
<a href="namespaces/arangodb-auth.html" class="">Auth</a>
61-
62-
</li>
63-
<li>
64-
<a href="namespaces/arangodb-batch.html" class="">Batch</a>
65-
66-
</li>
67-
<li>
68-
<a href="namespaces/arangodb-collection.html" class="">Collection</a>
69-
70-
</li>
71-
<li>
72-
<a href="namespaces/arangodb-connection.html" class="">Connection</a>
73-
74-
</li>
75-
<li>
76-
<a href="namespaces/arangodb-cursor.html" class="">Cursor</a>
77-
78-
</li>
79-
<li>
80-
<a href="namespaces/arangodb-database.html" class="">Database</a>
81-
82-
</li>
83-
<li>
84-
<a href="namespaces/arangodb-datastructures.html" class="">DataStructures</a>
85-
86-
</li>
87-
<li>
88-
<a href="namespaces/arangodb-document.html" class="">Document</a>
89-
90-
</li>
91-
<li>
92-
<a href="namespaces/arangodb-entity.html" class="">Entity</a>
93-
94-
</li>
95-
<li>
96-
<a href="namespaces/arangodb-exceptions.html" class="">Exceptions</a>
97-
98-
</li>
99-
<li>
100-
<a href="namespaces/arangodb-foxx.html" class="">Foxx</a>
101-
102-
</li>
103-
<li>
104-
<a href="namespaces/arangodb-graph.html" class="">Graph</a>
105-
106-
</li>
107-
<li>
108-
<a href="namespaces/arangodb-http.html" class="">Http</a>
109-
110-
</li>
111-
<li>
112-
<a href="namespaces/arangodb-transaction.html" class="">Transaction</a>
113-
114-
</li>
115-
<li>
116-
<a href="namespaces/arangodb-validation.html" class="">Validation</a>
117-
118-
</li>
119-
<li>
120-
<a href="namespaces/arangodb-view.html" class="">View</a>
121-
122-
</li>
123-
</ul>
124-
125-
</section>
126-
<section class="phpdocumentor-sidebar__category">
127-
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
128-
<h4 class="phpdocumentor-sidebar__root-namespace">
129-
<a href="packages/ArangoDB.html" class="">ArangoDB</a>
130-
</h4>
131-
<ul class="phpdocumentor-list">
132-
<li>
133-
<a href="packages/ArangoDB-Admin.html" class="">Admin</a>
134-
135-
</li>
136-
<li>
137-
<a href="packages/ArangoDB-AQL.html" class="">AQL</a>
138-
139-
</li>
140-
<li>
141-
<a href="packages/ArangoDB-Auth.html" class="">Auth</a>
142-
143-
</li>
144-
<li>
145-
<a href="packages/ArangoDB-Batch.html" class="">Batch</a>
146-
147-
</li>
148-
<li>
149-
<a href="packages/ArangoDB-Collection.html" class="">Collection</a>
150-
151-
</li>
152-
<li>
153-
<a href="packages/ArangoDB-Connection.html" class="">Connection</a>
154-
155-
</li>
156-
<li>
157-
<a href="packages/ArangoDB-Cursor.html" class="">Cursor</a>
158-
159-
</li>
160-
<li>
161-
<a href="packages/ArangoDB-Database.html" class="">Database</a>
162-
163-
</li>
164-
<li>
165-
<a href="packages/ArangoDB-DataStructures.html" class="">DataStructures</a>
166-
167-
</li>
168-
<li>
169-
<a href="packages/ArangoDB-Document.html" class="">Document</a>
170-
171-
</li>
172-
<li>
173-
<a href="packages/ArangoDB-Handler.html" class="">Handler</a>
174-
175-
</li>
176-
<li>
177-
<a href="packages/ArangoDB-Exceptions.html" class="">Exceptions</a>
178-
179-
</li>
180-
<li>
181-
<a href="packages/ArangoDB-Validation.html" class="">Validation</a>
182-
183-
</li>
184-
<li>
185-
<a href="packages/ArangoDB-Foxx.html" class="">Foxx</a>
186-
187-
</li>
188-
<li>
189-
<a href="packages/ArangoDB-Graph.html" class="">Graph</a>
190-
191-
</li>
192-
<li>
193-
<a href="packages/ArangoDB-Http.html" class="">Http</a>
194-
195-
</li>
196-
<li>
197-
<a href="packages/ArangoDB-Transaction.html" class="">Transaction</a>
198-
199-
</li>
200-
<li>
201-
<a href="packages/ArangoDB-View.html" class="">View</a>
202-
203-
</li>
204-
</ul>
205-
206-
</section>
207-
208-
<section class="phpdocumentor-sidebar__category">
46+
<section class="phpdocumentor-sidebar__category -reports">
20947
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
21048
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
21149
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
21250
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
21351
</section>
21452

215-
<section class="phpdocumentor-sidebar__category">
53+
<section class="phpdocumentor-sidebar__category -indices">
21654
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
21755
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
21856
</section>

0 commit comments

Comments
 (0)