Skip to content
This repository was archived by the owner on Aug 9, 2022. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<apache.commons-collections.version>4.2</apache.commons-collections.version>
<apache.commons-io.version>2.6</apache.commons-io.version>
<apache.commons-text.version>1.9</apache.commons-text.version>
<remark.version>1.1.0</remark.version>
<remark.version>1.2.0</remark.version>
</properties>

<build>
Expand Down Expand Up @@ -127,8 +127,9 @@
<artifactId>jackson-dataformat-yaml</artifactId>
<version>${jackson.version}</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.kotcrab.remark/remark -->
<dependency>
<groupId>com.overzealous</groupId>
<groupId>com.kotcrab.remark</groupId>
Copy link
Contributor

@andrei-punko andrei-punko Apr 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, seems original artifact was removed from repo, so we should replace it with possible fork.
And it's mandatory change for person who hasn't legacy com.overzealous artifact in local maven repo.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I see

<artifactId>remark</artifactId>
<version>${remark.version}</version>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be it's reasonable to use existing constant remark.version (with 1.2.0 value) or remove it from properties

</dependency>
Expand Down Expand Up @@ -157,7 +158,7 @@

<repositories>
<repository>
<id>sprin-libs-repo</id>
<id>spring-libs-repo</id>
<name>Spring Lib Release repository</name>
<url>https://repo.spring.io/libs-release</url>
</repository>
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/microsoft/model/MetadataFileItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import java.util.List;

import org.apache.commons.lang3.RegExUtils;
import org.apache.commons.text.StringEscapeUtils;

@JsonPropertyOrder({"uid", "id", "parent", "children", "href", "langs", "isExternal", "name", "nameWithType",
"fullName", "overload", "overridden", "type", "package", "summary", "syntax", "inheritance", "implements", "exceptions",
Expand Down Expand Up @@ -160,7 +161,7 @@ public String getSummary() {
}

public void setSummary(String summary) {
this.summary = summary;
this.summary = StringEscapeUtils.unescapeJava(summary);
}

public Syntax getSyntax() {
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/microsoft/model/Return.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import com.fasterxml.jackson.annotation.JsonProperty;

import com.microsoft.util.XrefHelper;
import org.apache.commons.text.StringEscapeUtils;

public class Return {

Expand Down Expand Up @@ -34,7 +35,7 @@ public String getReturnDescription() {
}

public void setReturnDescription(String returnDescription) {
this.returnDescription = returnDescription;
this.returnDescription = StringEscapeUtils.unescapeJava(returnDescription);
}

public String getReturnXrefString() {
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/microsoft/model/TypeParameter.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.microsoft.model;

import com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.commons.text.StringEscapeUtils;

public class TypeParameter implements Comparable<TypeParameter> {

Expand All @@ -21,7 +22,7 @@ public String getDescription() {
}

public void setDescription(String description) {
this.description = description;
this.description = StringEscapeUtils.unescapeJava(description);
}

@Override
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/microsoft/util/FileUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.microsoft.model.YmlFile;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
Expand All @@ -16,7 +17,7 @@ public static void dumpToFile(String content, String fileName) {
try {
Path path = Paths.get(fileName);
Files.createDirectories(path.getParent());
Files.write(path, content.getBytes());
Files.write(path, content.getBytes(Charset.forName("UTF-8")));
} catch (IOException ioe) {
String exception = "Error during dump to file: " + fileName;
throw new RuntimeException(exception, ioe);
Expand Down
48 changes: 48 additions & 0 deletions src/test/java/com/microsoft/samples/noneascii/Offer.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package com.microsoft.samples.noneascii;


import java.net.URI;
import java.util.List;

/**
* 代表客户可用的产品形式
*/
public class Offer
{
/**
* 初始化Offer类的新实例。
*/
public Offer()
{
}

/**
* 获取或设置合作伙伴要求的资格,以便为客户购买优惠。
*/
private String[] __ResellerQualifications;

public String[] getResellerQualifications()
{
return __ResellerQualifications;
}

public void setResellerQualifications(String[] value)
{
__ResellerQualifications = value;
}

/**
* 获取或设置客户要求合作伙伴为客户购买的资格。
*/
private String[] __ReselleeQualifications;

public String[] getReselleeQualifications()
{
return __ReselleeQualifications;
}

public void setReselleeQualifications(String[] value)
{
__ReselleeQualifications = value;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### YamlMime:JavaMember
uid: "com.microsoft.samples.noneascii.Offer.Offer*"
fullName: "com.microsoft.samples.noneascii.Offer.Offer"
name: "Offer"
nameWithType: "Offer.Offer"
members:
- uid: "com.microsoft.samples.noneascii.Offer.Offer()"
fullName: "com.microsoft.samples.noneascii.Offer.Offer()"
name: "Offer()"
nameWithType: "Offer.Offer()"
summary: "初始化Offer类的新实例。"
syntax: "public Offer()"
type: "constructor"
metadata: {}
package: "com.microsoft.samples.noneascii"
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### YamlMime:JavaMember
uid: "com.microsoft.samples.noneascii.Offer.getReselleeQualifications*"
fullName: "com.microsoft.samples.noneascii.Offer.getReselleeQualifications"
name: "getReselleeQualifications"
nameWithType: "Offer.getReselleeQualifications"
members:
- uid: "com.microsoft.samples.noneascii.Offer.getReselleeQualifications()"
fullName: "com.microsoft.samples.noneascii.Offer.getReselleeQualifications()"
name: "getReselleeQualifications()"
nameWithType: "Offer.getReselleeQualifications()"
syntax: "public String[] getReselleeQualifications()"
returns:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />[]"
type: "method"
metadata: {}
package: "com.microsoft.samples.noneascii"
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### YamlMime:JavaMember
uid: "com.microsoft.samples.noneascii.Offer.getResellerQualifications*"
fullName: "com.microsoft.samples.noneascii.Offer.getResellerQualifications"
name: "getResellerQualifications"
nameWithType: "Offer.getResellerQualifications"
members:
- uid: "com.microsoft.samples.noneascii.Offer.getResellerQualifications()"
fullName: "com.microsoft.samples.noneascii.Offer.getResellerQualifications()"
name: "getResellerQualifications()"
nameWithType: "Offer.getResellerQualifications()"
syntax: "public String[] getResellerQualifications()"
returns:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />[]"
type: "method"
metadata: {}
package: "com.microsoft.samples.noneascii"
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### YamlMime:JavaMember
uid: "com.microsoft.samples.noneascii.Offer.setReselleeQualifications*"
fullName: "com.microsoft.samples.noneascii.Offer.setReselleeQualifications"
name: "setReselleeQualifications"
nameWithType: "Offer.setReselleeQualifications"
members:
- uid: "com.microsoft.samples.noneascii.Offer.setReselleeQualifications(java.lang.String[])"
fullName: "com.microsoft.samples.noneascii.Offer.setReselleeQualifications(String[] value)"
name: "setReselleeQualifications(String[] value)"
nameWithType: "Offer.setReselleeQualifications(String[] value)"
parameters:
- name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public void setReselleeQualifications(String[] value)"
type: "method"
metadata: {}
package: "com.microsoft.samples.noneascii"
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### YamlMime:JavaMember
uid: "com.microsoft.samples.noneascii.Offer.setResellerQualifications*"
fullName: "com.microsoft.samples.noneascii.Offer.setResellerQualifications"
name: "setResellerQualifications"
nameWithType: "Offer.setResellerQualifications"
members:
- uid: "com.microsoft.samples.noneascii.Offer.setResellerQualifications(java.lang.String[])"
fullName: "com.microsoft.samples.noneascii.Offer.setResellerQualifications(String[] value)"
name: "setResellerQualifications(String[] value)"
nameWithType: "Offer.setResellerQualifications(String[] value)"
parameters:
- name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public void setResellerQualifications(String[] value)"
type: "method"
metadata: {}
package: "com.microsoft.samples.noneascii"
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
### YamlMime:JavaType
uid: "com.microsoft.samples.noneascii.Offer"
fullName: "com.microsoft.samples.noneascii.Offer"
name: "Offer"
nameWithType: "Offer"
summary: "代表客户可用的产品形式"
inheritances:
- "<xref href=\"java.lang.Object\" data-throw-if-not-resolved=\"False\" />"
inheritedMembers:
- "java.lang.Object.clone()"
- "java.lang.Object.equals(java.lang.Object)"
- "java.lang.Object.finalize()"
- "java.lang.Object.getClass()"
- "java.lang.Object.hashCode()"
- "java.lang.Object.notify()"
- "java.lang.Object.notifyAll()"
- "java.lang.Object.toString()"
- "java.lang.Object.wait()"
- "java.lang.Object.wait(long)"
- "java.lang.Object.wait(long,int)"
syntax: "public class Offer"
constructors:
- "com.microsoft.samples.noneascii.Offer.Offer()"
methods:
- "com.microsoft.samples.noneascii.Offer.getReselleeQualifications()"
- "com.microsoft.samples.noneascii.Offer.getResellerQualifications()"
- "com.microsoft.samples.noneascii.Offer.setReselleeQualifications(java.lang.String[])"
- "com.microsoft.samples.noneascii.Offer.setResellerQualifications(java.lang.String[])"
type: "class"
metadata: {}
package: "com.microsoft.samples.noneascii"
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### YamlMime:JavaPackage
uid: "com.microsoft.samples.noneascii"
fullName: "com.microsoft.samples.noneascii"
name: "com.microsoft.samples.noneascii"
classes:
- "com.microsoft.samples.noneascii.Offer"
metadata: {}
package: "com.microsoft.samples.noneascii"
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uid: "com.microsoft.samples.subpackage.Person"
fullName: "com.microsoft.samples.subpackage.Person<T>"
name: "Person<T>"
nameWithType: "Person<T>"
summary: "Class that describes some person This comment has links to:\n\n * Owner class <xref uid=\"com.microsoft.samples.subpackage.Person\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person\"></xref>\n * Its inner class <xref uid=\"com.microsoft.samples.subpackage.Person.IdentificationInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person.IdentificationInfo\"></xref>\n * Its method <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person#setLastName(String lastName)\"></xref>\n * Its method without params <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person#setLastName()\"></xref>\n * Its public field <xref uid=\"com.microsoft.samples.subpackage.Person.age\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person#age\"></xref>\n * Another class which used here <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Set\"></xref>\n * Another class which not used here <xref uid=\"java.util.List\" data-throw-if-not-resolved=\"false\" data-raw-source=\"List\"></xref>\n * Broken link <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"sdfdsagdsfghfgh\"></xref>\n * Plain link <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"someContent\"></xref>\n * Link that starts from '\\#' <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setLastName()\"></xref>\n * Link with label <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WordOne\"></xref>\n\nThis is an \"at\" symbol: @"
summary: "Class that describes some person This comment has links to:\n\n * Owner class <xref uid=\"com.microsoft.samples.subpackage.Person\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person\"></xref>\n * Its inner class <xref uid=\"com.microsoft.samples.subpackage.Person.IdentificationInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person.IdentificationInfo\"></xref>\n * Its method <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person#setLastName(String lastName)\"></xref>\n * Its method without params <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person#setLastName()\"></xref>\n * Its public field <xref uid=\"com.microsoft.samples.subpackage.Person.age\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Person#age\"></xref>\n * Another class which used here <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Set\"></xref>\n * Another class which not used here <xref uid=\"java.util.List\" data-throw-if-not-resolved=\"false\" data-raw-source=\"List\"></xref>\n * Broken link <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"sdfdsagdsfghfgh\"></xref>\n * Plain link <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"someContent\"></xref>\n * Link that starts from '#' <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setLastName()\"></xref>\n * Link with label <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WordOne\"></xref>\n\nThis is an \"at\" symbol: @"
inheritances:
- "<xref href=\"java.lang.Object\" data-throw-if-not-resolved=\"False\" />"
inheritedMembers:
Expand Down
21 changes: 21 additions & 0 deletions src/test/resources/expected-generated-files/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,27 @@
- uid: "com.microsoft.samples.commentinheritance.Viviparous.giveBirth*"
name: "giveBirth"
type: "method"
- uid: "com.microsoft.samples.noneascii"
name: "com.microsoft.samples.noneascii"
items:
- uid: "com.microsoft.samples.noneascii.Offer"
name: "Offer"
items:
- uid: "com.microsoft.samples.noneascii.Offer.Offer*"
name: "Offer"
type: "constructor"
- uid: "com.microsoft.samples.noneascii.Offer.getReselleeQualifications*"
name: "getReselleeQualifications"
type: "method"
- uid: "com.microsoft.samples.noneascii.Offer.getResellerQualifications*"
name: "getResellerQualifications"
type: "method"
- uid: "com.microsoft.samples.noneascii.Offer.setReselleeQualifications*"
name: "setReselleeQualifications"
type: "method"
- uid: "com.microsoft.samples.noneascii.Offer.setResellerQualifications*"
name: "setResellerQualifications"
type: "method"
- uid: "com.microsoft.samples.offers"
name: "com.microsoft.samples.offers"
items:
Expand Down