Skip to content

Commit

Permalink
Added fitAll() service documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ylussaud committed Oct 27, 2023
1 parent a4eac35 commit cb61eaf
Show file tree
Hide file tree
Showing 13 changed files with 45 additions and 14 deletions.
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_booleanservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_excelservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
18 changes: 17 additions & 1 deletion ref-doc/nightly/m2doc_service_imageservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down Expand Up @@ -51,6 +51,22 @@ Convert a String representing an URI to an Image and serialize it in the given f
* 'image.png'.asImage('jpg')
* insert the image 'image.jpg'

## org.obeonetwork.m2doc.element.MElement.fitAll(Integer, Integer, boolean) : org.obeonetwork.m2doc.element.MElement

Fits all Images of the given MElement in the given rectangle width and height.

### Parameter

* **element**: The MElement
* **width**: The width to fit
* **height**: The height to fit
* **zoomIn**: The image will be zoomed in if smaller

### Example

* myImage.fitAll(200, 300, false)
* will fit all images in a rectangle (width=200, height=300) if the original image size is smaller it will not be zoomed in

## org.obeonetwork.m2doc.element.MImage.fit(Integer, Integer) : org.obeonetwork.m2doc.element.MImage

Fits the Image in the given rectangle width and height. same as myImage.fit(width, height, true)
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_linkservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_m2doceobjectservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
19 changes: 17 additions & 2 deletions ref-doc/nightly/m2doc_service_m2docgenservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down Expand Up @@ -159,6 +159,21 @@ Tell if the given DRepresentation is visible in LM.
* myDRepresentation.isVisibleInDoc({some::Extension1 | some::Extension2})
* true if the given DRepresentation is visible in LM, false otherwise

## org.obeonetwork.m2doc.element.MElement.reduceAllImages(Integer, Integer) : org.obeonetwork.m2doc.element.MElement

Reduces all MImages from the given MElement to a maximum of the given size. Smaller images will not be changed.

### Parameter

* **element**: The given MElement
* **width**: The maximum width
* **height**: The maximum height

### Example

* myMElement.reduceAllImages(200, 300)
* all reduced MImages from the given MElement

## org.obeonetwork.m2doc.element.MElement.replaceLink(EObject) : org.obeonetwork.m2doc.element.MElement

Replace the MLink uri from the given MElement to reference document bookmarks.
Expand All @@ -170,7 +185,7 @@ Replace the MLink uri from the given MElement to reference document bookmarks.

### Example

* myDataPkg.replaceLink(eObj)
* myMElement.replaceLink(eObj)
* replaced the MLink uri from the given MElement to reference document bookmarks


Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_m2dochtmlservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_m2docsiriusservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_m2docwikitextservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_paginationservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_promptservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_semanticbrowserservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down
2 changes: 1 addition & 1 deletion ref-doc/nightly/m2doc_service_swtpromptservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ relativePath: ../..

<!--
/********************************************************************************
** Copyright (c) 2015 Obeo.
** Copyright (c) 2015, 2023 Obeo.
** All rights reserved. This program and the accompanying materials
** are made available under the terms of the Eclipse Public License v2.0
** which accompanies this distribution, and is available at
Expand Down

0 comments on commit cb61eaf

Please sign in to comment.