You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by wa...@apache.org on 2021/06/05 19:50:15 UTC

[olingo-site] 11/15: cleanup of odata2 docs

This is an automated email from the ASF dual-hosted git repository.

wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/olingo-site.git

commit c5cfd8b8a00fc2b7aa0da1166923fed55e7e323a
Author: Dave Fisher <da...@davefisher.tech>
AuthorDate: Sat Jun 5 09:24:12 2021 -0700

    cleanup of odata2 docs
---
 content/doc/odata2/eclipse.md                     | 4 +---
 content/doc/odata2/index.md                       | 8 ++++----
 content/doc/odata2/tutorials/debug.md             | 4 ++--
 content/doc/odata2/tutorials/jpafunctionimport.md | 8 ++++----
 4 files changed, 11 insertions(+), 13 deletions(-)

diff --git a/content/doc/odata2/eclipse.md b/content/doc/odata2/eclipse.md
index 8ef53ea..75aa307 100644
--- a/content/doc/odata2/eclipse.md
+++ b/content/doc/odata2/eclipse.md
@@ -8,8 +8,6 @@ Title:     Eclipse
 
 With the Maven project files can be generated with:
 
-```
-mvn eclipse:clean eclipse:eclipse
-```
+`mvn eclipse:clean eclipse:eclipse`
 
 As result each Maven module will get a consistent `.project`, `.classpath` and `.settings` file with which each module can be imported as existing project to Eclipse. 
diff --git a/content/doc/odata2/index.md b/content/doc/odata2/index.md
index 0151ec5..bcc0484 100644
--- a/content/doc/odata2/index.md
+++ b/content/doc/odata2/index.md
@@ -47,7 +47,7 @@ Title:     Documentation
 
 ### Javadoc
 
-* [Javadoc for OData 2.0 Library](/javadoc/odata2)
+* [Javadoc for OData 2.0 Library](/javadoc/odata2/)
 
 ### Olingo Project Setup (Contributors)
 
@@ -57,6 +57,6 @@ Title:     Documentation
 
 
 
-  [1]: http://olingo.apache.org/doc/odata2/tutorials/DeltaQuerySupport.html
-  [2]: http://olingo.apache.org/doc/odata2/tutorials/HandlingClobAndBlob.html
-  [3]: http://olingo.apache.org/doc/odata2/tutorials/CustomODataJPAProcessor.html
+  [1]: /doc/odata2/tutorials/DeltaQuerySupport.html
+  [2]: /doc/odata2/tutorials/HandlingClobAndBlob.html
+  [3]: /doc/odata2/tutorials/CustomODataJPAProcessor.html
diff --git a/content/doc/odata2/tutorials/debug.md b/content/doc/odata2/tutorials/debug.md
index 1f44c25..08637d0 100644
--- a/content/doc/odata2/tutorials/debug.md
+++ b/content/doc/odata2/tutorials/debug.md
@@ -53,7 +53,7 @@ If this is in place then the url query option odata-debug=json will return detai
 
 ##### Query for Debug Information
 
-** JSON Debug View**
+**JSON Debug View**
 
 Request url: http://localhost:8080/olingo-odata2-ref-web/ReferenceScenario.svc/?odata-debug=json
 
@@ -112,7 +112,7 @@ Response:
 	}
 ```
 
-** HTML Debug View**
+**HTML Debug View**
 
 Request url: http://localhost:8080/olingo-odata2-ref-web/ReferenceScenario.svc/?odata-debug=html
 to get a self-contained HTML document with all information that is in the JSON
diff --git a/content/doc/odata2/tutorials/jpafunctionimport.md b/content/doc/odata2/tutorials/jpafunctionimport.md
index 446a9fb..afe5223 100644
--- a/content/doc/odata2/tutorials/jpafunctionimport.md
+++ b/content/doc/odata2/tutorials/jpafunctionimport.md
@@ -150,7 +150,7 @@ OData JPA Processor Library is enhanced to:
 
 3. Create a Java class by implementing the interface *org.apache.olingo.odata2.jpa.processor.api.model* to register the annotated Java methods.
 
-```java
+   ```java
     public class SalesOrderProcessingExtension implements JPAEdmExtension {
       @Override
       public void extendJPAEdmSchema(final JPAEdmSchemaView arg0 {
@@ -162,15 +162,15 @@ OData JPA Processor Library is enhanced to:
         view.registerOperations(SalesOrderHeaderProcessor.class, null);
       }
     }
-```
+   ```
 
 *Note*: Use the method *extendWithOperation* to register the list of classes and the methods within the class that needs to be exposed as Function Imports. If the second parameter is passed null, then the OData JPA Processor Library would consider all the annotated methods within the class for Function Import. However, you could also restrict the list of methods that needs to be transformed into function imports within a Java class by passing an array of Java method names as the second p [...]
 
 4. Register the class created in step 3 with *ODataJPAContext* as shown below. The registration can be done during the initialization of *ODataJPAContext* in OData JPA Service Factory along with initializing persistence unit name, entity manager factory instance and optional mapping model.
 
-```java
+   ```java
     oDataJPAContext.setJPAEdmExtension((JPAEdmExtension) new SalesOrderProcessingExtension());
-```
+   ```
 
 *Note*: You must register the class because the OData JPA Processor Library should be informed about the list of Java methods that it needs to process in a project. If we do not register, then OData JPA Processor Library should scan all the classes and the methods in the Java project looking for EDM annotations. In order to avoid such overload, it is mandatory to specify the list of Java methods that shall be transformed into function imports in a class.