Skip to content

Commit

Permalink
Issue IMCMS-522: Add and update documentation by RB-6
Browse files Browse the repository at this point in the history
- Add warnings
  • Loading branch information
VictorPavfurious committed Oct 19, 2020
1 parent a958856 commit 550f3ee
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/API-documentation/service-beans/commonContentService.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ In this article:
- `Introduction`_
- `Use API`_

.. warning::
This init instance over Imcms.getServices().getCommonContentService() working from 10 version

Introduction
------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ In this article:
- `The most important setters/getters for Document`_


.. warning::
This init instance over Imcms.getServices().getDocumentService() working from 10 version

Introduction
------------
Expand Down
4 changes: 4 additions & 0 deletions docs/API-documentation/service-beans/documentUrlService.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
DocumentUrlService
==================


.. warning::
This init instance over Imcms.getServices().getDocumentUrlService() working from 10 version

Init or get instance DocumentUrlService over global Imcms.getServices ``Imcms.getServices().getDocumentUrlService();``

.. code-block:: jsp
Expand Down
2 changes: 2 additions & 0 deletions docs/API-documentation/service-beans/imageFileService.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ ImageFileService
================


In order to init ImageFileService need to use - ``Imcms.getServices().getManagedBean(ImageFileService.class)``

Use API
-------
.. code-block:: java
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ImageFolderService
==================


In order to init ImageFolderService need to use - ``Imcms.getServices().getManagedBean(ImageFolderService.class)``

Use API
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ ImageHistoryService
===================


Imcms.getServices().getManagedBean(ImageHistoryService.class)
In order to init ImageHistoryService need to use - Imcms.getServices().getManagedBean(ImageHistoryService.class)

Use API
-------
Expand Down
3 changes: 3 additions & 0 deletions docs/API-documentation/service-beans/imageService.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ In this article:
- `Description fields imageDTO`_


.. warning::
This init instance over Imcms.getServices().getImageService() working from 10 version

Use API
-------

Expand Down
3 changes: 3 additions & 0 deletions docs/API-documentation/service-beans/loopService.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ In this article:
- `Example usages loopService API`_


.. warning::
This init instance over Imcms.getServices().getLoopService() working from 10 version

Use API
-------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ TextDocumentTemplateService

Init or get instance TextDocumentTemplateService over global Imcms.getServices ``Imcms.getServices().getTextDocumentTemplateService();``

.. warning::
This init instance over Imcms.getServices().getTextDocumentTemplateService() working from 10 version

Use API
-------

Expand Down
3 changes: 3 additions & 0 deletions docs/API-documentation/service-beans/userService.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ UserService

Init or get instance UserService over global Imcms.getServices ``Imcms.getServices().getUserService();``

.. warning::
This init instance over Imcms.getServices().getUserService() working from 10 version

.. code-block:: jsp
User getUser(int id) throws UserNotExistsException;
Expand Down
3 changes: 3 additions & 0 deletions docs/API-documentation/service-beans/versionService.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ VersionService

Init or get instance VersionService over global Imcms.getServices ``Imcms.getServices().getVersionService();``

.. warning::
This init instance over Imcms.getServices().getVersionService() working from 10 version

.. code-block:: jsp
Version getDocumentWorkingVersion(int docId);
Expand Down

0 comments on commit 550f3ee

Please sign in to comment.