Skip to content

Commit 170bf8c

Browse files
vrichard12vrichard12
committed
[SAFRAN-1071] Generate M2Doc documentation for database partial view diagrams
1 parent 8ebca7a commit 170bf8c

3 files changed

Lines changed: 98 additions & 0 deletions

File tree

‎m2doc/database/plugins/org.obeonetwork.database.m2doc.services/doc/pages/index.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,20 @@ <h3>Diagram Schema Diagram</h3>
114114
<li>Default (ID: Default)</lil>
115115
<li>External Tables (ID: External Tables)</lil>
116116
<li>Index (ID: Index)</lil>
117+
</ul></p>
118+
<h3>Diagram Database Partial View</h3>
119+
<p>ID:
120+
Database Partial View </p>
121+
<p>Layers:<ul>
122+
<li>Default (ID: Default)</lil>
123+
<li>Index (ID: Index)</lil>
124+
</ul></p>
125+
<h3>Diagram Schema Partial View</h3>
126+
<p>ID:
127+
Schema Partial View </p>
128+
<p>Layers:<ul>
129+
<li>Default (ID: Default)</lil>
130+
<li>Index (ID: Index)</lil>
117131
</ul></p>
118132
</section>
119133
</div>

‎m2doc/database/plugins/org.obeonetwork.database.m2doc.services/doc/pages/m2doc_services_database.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,48 @@ <h2 id="Services">Services</h2>
230230
<td colspan="1" rowspan="1">Return first annotation with the specified title.</td>
231231
<td colspan="1" rowspan="1">{m:myObeoDSMObject.annotation('some title')} returns: The string of the annotation.</td>
232232
</tr>
233+
<tr>
234+
<td colspan="1" rowspan="1"><strong>asDatabaseImage</strong></td>
235+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
236+
<td colspan="1" rowspan="1">{m:database.asDatabaseImage(width, height)}</td>
237+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Database Database Diagrams scaled to the given width and heigth.</td>
238+
<td colspan="1" rowspan="1">{m:database.asDatabaseImage(400, 300)} returns: A sequence of images.</td>
239+
</tr>
240+
<tr>
241+
<td colspan="1" rowspan="1"><strong>asDatabaseImage</strong></td>
242+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
243+
<td colspan="1" rowspan="1">{m:database.asDatabaseImage()}</td>
244+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Database Database Diagrams.</td>
245+
<td colspan="1" rowspan="1">{m:database.asDatabaseImage()} returns: A sequence of images.</td>
246+
</tr>
247+
<tr>
248+
<td colspan="1" rowspan="1"><strong>asDatabaseImage</strong></td>
249+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
250+
<td colspan="1" rowspan="1">{m:database.asDatabaseImage(width)}</td>
251+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Database Database Diagrams scaled to the given width keeping the initial image ratio.</td>
252+
<td colspan="1" rowspan="1">{m:database.asDatabaseImage(400)} returns: A sequence of images.</td>
253+
</tr>
254+
<tr>
255+
<td colspan="1" rowspan="1"><strong>asDatabasePartialViewImage</strong></td>
256+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
257+
<td colspan="1" rowspan="1">{m:database.asDatabasePartialViewImage()}</td>
258+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Database Database Partial View Diagrams.</td>
259+
<td colspan="1" rowspan="1">{m:database.asDatabasePartialViewImage()} returns: A sequence of images.</td>
260+
</tr>
261+
<tr>
262+
<td colspan="1" rowspan="1"><strong>asDatabasePartialViewImage</strong></td>
263+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
264+
<td colspan="1" rowspan="1">{m:database.asDatabasePartialViewImage(width)}</td>
265+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Database Database Partial View Diagrams scaled to the given width keeping the initial image ratio.</td>
266+
<td colspan="1" rowspan="1">{m:database.asDatabasePartialViewImage(400)} returns: A sequence of images.</td>
267+
</tr>
268+
<tr>
269+
<td colspan="1" rowspan="1"><strong>asDatabasePartialViewImage</strong></td>
270+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
271+
<td colspan="1" rowspan="1">{m:database.asDatabasePartialViewImage(width, height)}</td>
272+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Database Database Partial View Diagrams scaled to the given width and heigth.</td>
273+
<td colspan="1" rowspan="1">{m:database.asDatabasePartialViewImage(400, 300)} returns: A sequence of images.</td>
274+
</tr>
233275
<tr>
234276
<td colspan="1" rowspan="1"><strong>cinematicIcon</strong></td>
235277
<td colspan="1" rowspan="1">org.obeonetwork.m2doc.element.MImage</td>

‎m2doc/database/plugins/org.obeonetwork.database.m2doc.services/doc/pages/m2doc_services_schema.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,48 @@ <h2 id="Services">Services</h2>
181181
<td colspan="1" rowspan="1">Return first annotation with the specified title.</td>
182182
<td colspan="1" rowspan="1">{m:myObeoDSMObject.annotation('some title')} returns: The string of the annotation.</td>
183183
</tr>
184+
<tr>
185+
<td colspan="1" rowspan="1"><strong>asSchemaImage</strong></td>
186+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
187+
<td colspan="1" rowspan="1">{m:schema.asSchemaImage(width, height)}</td>
188+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Schema Schema Diagrams scaled to the given width and heigth.</td>
189+
<td colspan="1" rowspan="1">{m:schema.asSchemaImage(400, 300)} returns: A sequence of images.</td>
190+
</tr>
191+
<tr>
192+
<td colspan="1" rowspan="1"><strong>asSchemaImage</strong></td>
193+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
194+
<td colspan="1" rowspan="1">{m:schema.asSchemaImage(width)}</td>
195+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Schema Schema Diagrams scaled to the given width keeping the initial image ratio.</td>
196+
<td colspan="1" rowspan="1">{m:schema.asSchemaImage(400)} returns: A sequence of images.</td>
197+
</tr>
198+
<tr>
199+
<td colspan="1" rowspan="1"><strong>asSchemaImage</strong></td>
200+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
201+
<td colspan="1" rowspan="1">{m:schema.asSchemaImage()}</td>
202+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Schema Schema Diagrams.</td>
203+
<td colspan="1" rowspan="1">{m:schema.asSchemaImage()} returns: A sequence of images.</td>
204+
</tr>
205+
<tr>
206+
<td colspan="1" rowspan="1"><strong>asSchemaPartialViewImage</strong></td>
207+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
208+
<td colspan="1" rowspan="1">{m:schema.asSchemaPartialViewImage()}</td>
209+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Schema Schema Partial View Diagrams.</td>
210+
<td colspan="1" rowspan="1">{m:schema.asSchemaPartialViewImage()} returns: A sequence of images.</td>
211+
</tr>
212+
<tr>
213+
<td colspan="1" rowspan="1"><strong>asSchemaPartialViewImage</strong></td>
214+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
215+
<td colspan="1" rowspan="1">{m:schema.asSchemaPartialViewImage(width)}</td>
216+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Schema Schema Partial View Diagrams scaled to the given width keeping the initial image ratio.</td>
217+
<td colspan="1" rowspan="1">{m:schema.asSchemaPartialViewImage(400)} returns: A sequence of images.</td>
218+
</tr>
219+
<tr>
220+
<td colspan="1" rowspan="1"><strong>asSchemaPartialViewImage</strong></td>
221+
<td colspan="1" rowspan="1">List of org.obeonetwork.m2doc.element.MImage</td>
222+
<td colspan="1" rowspan="1">{m:schema.asSchemaPartialViewImage(width, height)}</td>
223+
<td colspan="1" rowspan="1">Returns a collection of images representing the target Schema Schema Partial View Diagrams scaled to the given width and heigth.</td>
224+
<td colspan="1" rowspan="1">{m:schema.asSchemaPartialViewImage(400, 300)} returns: A sequence of images.</td>
225+
</tr>
184226
<tr>
185227
<td colspan="1" rowspan="1"><strong>cinematicIcon</strong></td>
186228
<td colspan="1" rowspan="1">org.obeonetwork.m2doc.element.MImage</td>

0 commit comments

Comments
 (0)