Issue IMCMS-522: Add and update documentation by RB-6

- Update and refactor documentation
imCodePartnerAB · Oct 6, 2020 · 0639e10 · 0639e10
1 parent da82d34
commit 0639e10
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 89 deletions.
diff --git a/docs/API-documentation/service-beans/MailService.rst b/docs/API-documentation/service-beans/MailService.rst
@@ -2,18 +2,12 @@ MailService
 ===========
 
 In this article:
-    - `Introduction`_
     - `Use API`_
 
-
-Introduction
-------------
-
-
 Use API
 -------
 
-Init or get instance LoopService over global Imcms.getServices ``Imcms.getServices().getLoopService();``
+Init or get instance MailService over global Imcms.getServices ``Imcms.getServices().getMailService();``
 
 .. code-block:: jsp
 

diff --git a/docs/API-documentation/service-beans/categoryService.rst b/docs/API-documentation/service-beans/categoryService.rst
@@ -13,7 +13,7 @@ Introduction
 Imcms has single interface support and different manipulation with categories for documents.
 We can easy, create/update/delete/get all categories over this bean CategoryService.
 Of course you can use old version category service with oldest API objects - you have to use CategoryMapper,
-more information about it `here <https://imcms.readthedocs.io/en/latest/API-documentation/service-beans/categoryMapper/>`
+more information about it :doc:`CategoryMapper</API-documentation/service-beans/categoryMapper>`
 That be init new bean CategoryService and work with methods need to look at the code below:
 
 Use API

diff --git a/docs/API-documentation/service-beans/commonContentService.rst b/docs/API-documentation/service-beans/commonContentService.rst
@@ -27,7 +27,7 @@ Use API
 
     <T extends CommonContent> void save(int docId, Collection<T> saveUs);
 
-    Set<CommonContent> getByVersion(Version version); //``see documentation versionService how to get Version``
+    Set<CommonContent> getByVersion(Version version);
 
     deleteByDocId(Integer docId);
 

diff --git a/docs/API-documentation/service-beans/documentUrlService.rst b/docs/API-documentation/service-beans/documentUrlService.rst
@@ -1,15 +1,6 @@
 DocumentUrlService
 ------------------
 
-In this article:
-    - `Use API`_
-    - `Description about DocumentUrl`_
-
-
-
-Use API
--------
-
 Init or get instance DocumentUrlService over global Imcms.getServices ``Imcms.getServices().getDocumentUrlService();``
 
 .. code-block:: jsp

diff --git a/docs/API-documentation/service-beans/imageService.rst b/docs/API-documentation/service-beans/imageService.rst
@@ -52,7 +52,7 @@ Description fields imageDTO
 ``setAllLanguage(boolean)`` - support all language image;
 ``setAlternateText(String)`` - alternative text for image;
 ``setSizeFormatted(String)`` - current size image (GB, Mb and etc)
-``setLoopEntryRef(LoopEntryRefDTO)`` - location into loop-area. (Check about loopEntryRef in `here <https://imcms.readthedocs.io/en/latest/API-documentation/service-beans/loopService/>`_.)
+``setLoopEntryRef(LoopEntryRefDTO)`` - location into loop-area. (Check about loopEntryRef in :doc:`LoopService</API-documentation/service-beans/loopService>`.)
 ``setFormat(Format)`` - set current format image;
 ``setCropRegion(ImageCropRegionDTO)`` - x1,x2,y1,y2 crop region for image;
 ``setSource(ImageSource)``

diff --git a/docs/API-documentation/service-beans/loopService.rst b/docs/API-documentation/service-beans/loopService.rst
@@ -2,12 +2,8 @@ LoopService
 ===========
 
 In this article:
-    - `Introduction`_
     - `Use API`_
-
-
-Introduction
-------------
+    - `Description about LoopEntry objects`_
 
 
 Use API
@@ -33,3 +29,10 @@ Init or get instance LoopService over global Imcms.getServices ``Imcms.getServic
 
     Imcms.getServices().getLoopService().createVersionedContent(Version workingVersion, Version newVersion);
 
+Description about LoopEntry objects
+-----------------------------------
+
+Loop -
+
+LoopEntryRef -
+
diff --git a/docs/API-documentation/service-beans/menuService.rst b/docs/API-documentation/service-beans/menuService.rst
@@ -1,19 +1,6 @@
 MenuService
 ===========
 
-
-In this article:
-    - `Introduction`_
-    - `Use API`_
-
-
-
-Introduction
-------------
-
-Use API
--------
-
 Init or get instance MenuService over global Imcms.getServices ``Imcms.getServices().getMenuService();``
 
 .. code-block:: jsp

diff --git a/docs/API-documentation/service-beans/templateService.rst b/docs/API-documentation/service-beans/templateService.rst
@@ -1,19 +1,6 @@
 TemplateService
 ===============
 
-
-In this article:
-    - `Introduction`_
-    - `Use API`_
-
-
-
-Introduction
-------------
-
-Use API
--------
-
 Init or get instance TemplateService over global Imcms.getServices ``Imcms.getServices().getTemplateService();``
 
 .. code-block:: jsp

diff --git a/docs/API-documentation/service-beans/textDocumentTemplateService.rst b/docs/API-documentation/service-beans/textDocumentTemplateService.rst
@@ -2,18 +2,6 @@ TextDocumentTemplateService
 ===========================
 
 
-In this article:
-    - `Introduction`_
-    - `Use API`_
-
-
-
-Introduction
-------------
-
-Use API
--------
-
 Init or get instance TextDocumentTemplateService over global Imcms.getServices ``Imcms.getServices().getTextDocumentTemplateService();``
 
 .. code-block:: jsp

diff --git a/docs/API-documentation/service-beans/userService.rst b/docs/API-documentation/service-beans/userService.rst
@@ -1,19 +1,6 @@
 UserService
 ===========
 
-
-In this article:
-    - `Introduction`_
-    - `Use API`_
-
-
-
-Introduction
-------------
-
-Use API
--------
-
 Init or get instance UserService over global Imcms.getServices ``Imcms.getServices().getUserService();``
 
 .. code-block:: jsp

diff --git a/docs/API-documentation/service-beans/versionService.rst b/docs/API-documentation/service-beans/versionService.rst
@@ -1,19 +1,6 @@
 VersionService
 ==============
 
-
-In this article:
-    - `Introduction`_
-    - `Use API`_
-
-
-
-Introduction
-------------
-
-Use API
--------
-
 Init or get instance VersionService over global Imcms.getServices ``Imcms.getServices().getVersionService();``
 
 .. code-block:: jsp
@@ -40,4 +27,7 @@ Init or get instance VersionService over global Imcms.getServices ``Imcms.getSer
 
     boolean hasNewerVersion(int docId);
 
-    void updateWorkingVersion(int docId);
+    void updateWorkingVersion(int docId);
+
+
+About function interface you can read `here <https://www.baeldung.com/java-8-functional-interfaces/>`_.