[docs] Add @PrivateAPI within the API documentation.

Signed-off-by: Stéphane Galland <galland@arakhne.org>
sarl · Oct 17, 2017 · 27e7c91 · 27e7c91
1 parent ad7954e
commit 27e7c91
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/main/apiplugins/io.sarl.core/src/io/sarl/core/AgentTask.sarl b/main/apiplugins/io.sarl.core/src/io/sarl/core/AgentTask.sarl
@@ -107,6 +107,7 @@ class AgentTask extends SRESpecificDataContainer {
 	 *
 	 * @param name name of the task.
 	 * @since 0.7, it is part of the private API.
+	 * @privateapi
 	 */
 	@PrivateAPI
 	def setTaskName(name : String) : void {

diff --git a/main/coreplugins/io.sarl.lang.core/src/io/sarl/lang/core/SREutils.java b/main/coreplugins/io.sarl.lang.core/src/io/sarl/lang/core/SREutils.java
@@ -50,6 +50,7 @@
  * @mavengroupid $GroupId$
  * @mavenartifactid $ArtifactId$
  * @since 0.5
+ * @privateapi
  */
 @PrivateAPI
 public final class SREutils {

diff --git a/pom.xml b/pom.xml
@@ -720,6 +720,11 @@
 							<tag>
 								<name>model</name>
 								<placement>a</placement>
+								<head>Private API</head>
+							</tag>
+							<tag>
+								<name>privateapi</name>
+								<placement>a</placement>
 								<head>Model element</head>
 							</tag>
 							<tag>