-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[releng] Update M2Doc documentation services
- Loading branch information
1 parent
d131207
commit 1831291
Showing
9 changed files
with
226 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 188 additions & 0 deletions
188
...org.obeonetwork.cinematic.m2doc.services/doc/pages/m2doc_services_metadatadefinition.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <!-- | ||
| /******************************************************************************** | ||
| ** Copyright (c) 2008, 2021 Obeo. | ||
| ** All rights reserved. This program and the accompanying materials | ||
| ** are made available under the terms of the Eclipse Public License v1.0 | ||
| ** which accompanies this distribution, and is available at | ||
| ** http://www.eclipse.org/legal/epl-v10.html | ||
| ** | ||
| ** Contributors: | ||
| ** Obeo - initial API and implementation | ||
| *********************************************************************************/ | ||
| --> | ||
| <head> | ||
| <meta charset="utf-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> | ||
| <meta name="description" content=""/> | ||
| <meta name="author" content="Obeo"/> | ||
| <!-- IE6-8 support of HTML elements --> | ||
| <!--if lt IE 9> | ||
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> | ||
| <!endif--> | ||
| <link href="../assets/css/bootstrap.css" rel="stylesheet"/> | ||
| <link href="../assets/css/docs.css" rel="stylesheet"/> | ||
| <title>M2Doc Services and attributes for MetaDataDefinition</title> | ||
| </head> | ||
|
|
||
| <body> | ||
| <header class="jumbotron subhead" id="overview"> | ||
| </header> | ||
|
|
||
| <h1 id="MetaDataDefinition">Services and attributes for the MetaDataDefinition concept</h1> | ||
| <div class="page-header"> | ||
| <h2 id="Attributes">Attributes</h2> | ||
| </div> | ||
| <table class="table table-striped"> | ||
| <thead> | ||
| <tr> | ||
| <th colspan="1" rowspan="1">Name</th> | ||
| <th colspan="1" rowspan="1">Returned type</th> | ||
| <th colspan="1" rowspan="1">M2Doc Syntax</th> | ||
| <th colspan="1" rowspan="1">Description</th> | ||
| <th colspan="1" rowspan="1">Example</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>body</strong></td> | ||
| <td colspan="1" rowspan="1">EString</td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.body}</td> | ||
| <td colspan="1" rowspan="1">The body of the annotation.</td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.body}</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>help</strong></td> | ||
| <td colspan="1" rowspan="1">EString</td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.help}</td> | ||
| <td colspan="1" rowspan="1"></td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.help}</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>technicalid</strong></td> | ||
| <td colspan="1" rowspan="1">EString</td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.technicalid}</td> | ||
| <td colspan="1" rowspan="1">Technical identifier of the element.</td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.technicalid}</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>title</strong></td> | ||
| <td colspan="1" rowspan="1">EString</td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.title}</td> | ||
| <td colspan="1" rowspan="1">The title of the annotation.</td> | ||
| <td colspan="1" rowspan="1">{m:metaDataDefinition.title}</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <div class="page-header"> | ||
| <h2 id="Services">Services</h2> | ||
| </div> | ||
| <table class="table table-striped"> | ||
| <thead> | ||
| <tr> | ||
| <th colspan="1" rowspan="1">Name</th> | ||
| <th colspan="1" rowspan="1">Returned type</th> | ||
| <th colspan="1" rowspan="1">M2Doc Syntax</th> | ||
| <th colspan="1" rowspan="1">Description</th> | ||
| <th colspan="1" rowspan="1">Example</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>allRelatedRequirements</strong></td> | ||
| <td colspan="1" rowspan="1">List of <a href="/help/topic/org.obeonetwork.dsl.requirement.m2doc.services/doc/pages/m2doc_services_requirement.html">Requirement</a></td> | ||
| <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()}</td> | ||
| <td colspan="1" rowspan="1">Returns a list of all the Requirements related to the target object or one of its sub objects. The result is a list with no duplicates sorted against the requirements ids.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.allRelatedRequirements()->sep(',')} returns: A comma separated list of related requirements.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>cinematicIcon</strong></td> | ||
| <td colspan="1" rowspan="1">org.obeonetwork.m2doc.element.MImage</td> | ||
| <td colspan="1" rowspan="1">{m:obj.cinematicIcon()}</td> | ||
| <td colspan="1" rowspan="1">Returns the presentation icon of the target Cinematic element.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.getCinematicIcon()} returns: The icon of the element.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>cinematicLabel</strong></td> | ||
| <td colspan="1" rowspan="1">String</td> | ||
| <td colspan="1" rowspan="1">{m:obj.cinematicLabel()}</td> | ||
| <td colspan="1" rowspan="1">Returns the presentation label of the target Cinematic element.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.getCinematicLabel()} returns: The label of the element.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>getDocumentTitle</strong></td> | ||
| <td colspan="1" rowspan="1">String</td> | ||
| <td colspan="1" rowspan="1">{m:doc.getDocumentTitle()}</td> | ||
| <td colspan="1" rowspan="1">Returns the title of the document.</td> | ||
| <td colspan="1" rowspan="1">{m:doc.getDocumentTitle()} returns: The title of the document.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>getDocumentTitle</strong></td> | ||
| <td colspan="1" rowspan="1">String</td> | ||
| <td colspan="1" rowspan="1">{m:myAnnotation.getDocumentTitle()}</td> | ||
| <td colspan="1" rowspan="1">Returns the title of the document if the given Annotation is a document link.</td> | ||
| <td colspan="1" rowspan="1">{m:myAnnotation.getDocumentTitle()} returns: The title of the document.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>getDocumentedObject</strong></td> | ||
| <td colspan="1" rowspan="1">EObject</td> | ||
| <td colspan="1" rowspan="1">{m:doc.getDocumentedObject()}</td> | ||
| <td colspan="1" rowspan="1">Returns the object this document is attached to.</td> | ||
| <td colspan="1" rowspan="1">{m:doc.getDocumentedObject()} returns: The documented object.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>getName</strong></td> | ||
| <td colspan="1" rowspan="1">String</td> | ||
| <td colspan="1" rowspan="1">{m:obj.getName()}</td> | ||
| <td colspan="1" rowspan="1">Returns the name of the given object if it defines one. Returns an empty string in all other cases.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.getName()} returns: The object name.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>getTypeName</strong></td> | ||
| <td colspan="1" rowspan="1">String</td> | ||
| <td colspan="1" rowspan="1">{m:obj.getTypeName()}</td> | ||
| <td colspan="1" rowspan="1">Returns the name of the given object's type, formatted with white spaces.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.getTypeName()} returns: A string representation of the given object's type.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>getTypeName</strong></td> | ||
| <td colspan="1" rowspan="1">String</td> | ||
| <td colspan="1" rowspan="1">{m:myEObject.getTypeName()}</td> | ||
| <td colspan="1" rowspan="1">Returns the name of the EClass of the given EObject.</td> | ||
| <td colspan="1" rowspan="1">{m:myEObject.getTypeName()} returns: ObeoDSMObject</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>hasRelatedRequirements</strong></td> | ||
| <td colspan="1" rowspan="1">boolean</td> | ||
| <td colspan="1" rowspan="1">{m:obj.hasRelatedRequirements()}</td> | ||
| <td colspan="1" rowspan="1">Returns true if the given Object as at least one related Requirement.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.hasRelatedRequirements()} returns: true or false.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>isCinematicObject</strong></td> | ||
| <td colspan="1" rowspan="1">boolean</td> | ||
| <td colspan="1" rowspan="1">{m:obj.isCinematicObject()}</td> | ||
| <td colspan="1" rowspan="1">Returns if the target object is a Cinematic element.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.isCinematicObject()} returns: True if the target object is a Cinematic element, false otherwise.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>relatedRequirements</strong></td> | ||
| <td colspan="1" rowspan="1">List of <a href="/help/topic/org.obeonetwork.dsl.requirement.m2doc.services/doc/pages/m2doc_services_requirement.html">Requirement</a></td> | ||
| <td colspan="1" rowspan="1">{m:obj.relatedRequirements()}</td> | ||
| <td colspan="1" rowspan="1">Returns the set of Requirement that are related to the target object.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.relatedRequirements()->sep(',')} returns: A comma separated list of related requirements.</td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1" rowspan="1"><strong>relatedRequirementsWithSubtype</strong></td> | ||
| <td colspan="1" rowspan="1">List of <a href="/help/topic/org.obeonetwork.dsl.requirement.m2doc.services/doc/pages/m2doc_services_requirement.html">Requirement</a></td> | ||
| <td colspan="1" rowspan="1">{m:obj.relatedRequirementsWithSubtype('SUBTYPE')}</td> | ||
| <td colspan="1" rowspan="1">Returns the list of Requirements that reference the target object and that have the specified subtype.</td> | ||
| <td colspan="1" rowspan="1">{m:obj.relatedRequirementsWithSubtype('performance')->sep(',')} returns: A comma separated list of related requirements of performance subtype.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </body> | ||
|
|
||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.