DTD hover/completion support for documentation

[Seiphon]

No description provided.

[angelozerr]

I think CMDTDElementDeclaration should provide a new method CMDTDElementDeclaration#getDocumentation(String attrName) which uses the DTDElementInfo (see next comment)

Replace with

this.documentation = elementDecl.getDocumentation(getName())

[angelozerr]

I think we should have just one Map hierarchiesMap which stores comment and hierarchies both (as value). To do that, I suggest that you create a private class which holds those information like:

static class DTDElementInfo {

	private final Set<String> hierarchies;
	private String comment;

	public DTDElementInfo() {
		this.hierarchies = new LinkedHashSet<String>();
		this.comment = null;
	}

	public Set<String> getHierarchies() {
		return hierarchies;
	}
	
	public String getComment() {
		return comment;
	}
		
	public void setComment(String comment) {
		this.comment = comment;
	}
}

hierarchiesMap should store String as key (like today) and DTDElementInfo as value.

[Seiphon]

Hi @angelozerr , by this way, we can collect the elements' comments and their child elements' comments. But how to collect attributes' commets? We can not just put attributes and its commet to hierarchiesMap, because there are some attributes have same name.

[angelozerr]

I forget the attribute case that you could manage like this:

static class DTDNodeInfo {

	private String comment;

	public DTDNodeInfo() {
		this.comment = null;
	}

	public String getComment() {
		return comment;
	}

	public void setComment(String comment) {
		this.comment = comment;
	}
}

static class DTDElementInfo extends DTDNodeInfo {

	private final Set<String> hierarchies;
	private final Map<String, DTDNodeInfo> attributes;
	
	public DTDElementInfo() {
		this.hierarchies = new LinkedHashSet<String>();
		this.attributes = new HashMap<>();
	}

	public Set<String> getHierarchies() {
		return hierarchies;
	}
	
	public String getComment(String attrName) {
		DTDNodeInfo attr = attributes.get(attrName);
		return attr != null ? attr.getComment() : null;
	}
}

[angelozerr]

use DTDElementInfo #setComment

[angelozerr]

@Seiphon your PR looks promising but I think we should avoir creating a new Map for comments. I think we should have a map which contains information of DTDElementInfo (hierachies + comments) for each element name.

See my comment with DTDElementInfo.

The second thing is that you support comments for attribute declaration but nor for element delclaration. Please support it too.

[angelozerr]

Please move those 2 classes on the top of the CMDTDDocument class.

[Seiphon]

Screenshot for element haver:

Screenshot for attribute haver:

The documentation style looks like these two pictures, it that ok?

[angelozerr]

service.xml doesn't exist as catalog. Please rename service.xml to catalog-liferay.xml and create this file catalog-liferay.xml to references your liferay-service-builder_7_2_0.dtd

[angelozerr]

The documentation style looks like these two pictures, it that ok?

For me I think it's a good start, perhaps we will improve it in an another PR (add title, format as markdown etc).

Please

• catalog for test (see my below comments)
• please update description of your commit like XSD 1.1 working #515

[angelozerr]

It's not a XML catalog. Please update this file with

<?xml version="1.0"?>
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
	<system
		systemId="http://www.liferay.com/dtd/liferay-service-builder_7_2_0.dtd"
		uri="../dtd/liferay-service-builder_7_2_0.dtd" />
</catalog>

To check that the XML catalog is working and uses the local liferay-service-builder_7_2_0.dtd, disconnect your Internet and try to execute your test.

[Seiphon]

Sorry, just got it. the pr has been updated.

[angelozerr]

It's perfect @Seiphon please update description of your commit like #515

Fixes #585

Signed-off-by:  ...

[Seiphon]

Hi @angelozerr, is that ok if I use commit description as follows:
DTD hover/completion support for documentation

Fixes #585

Signed-off-by: Seiphon Wang <[email protected]>

Is the title of the commit not corrent? or should I use DTD 1.1 working instead?

[angelozerr]

yes it's perfect!

[Seiphon]

I have already updated the description of this commit as mentioned in last comment.

[angelozerr]

Thanks a lot @Seiphon for your great PR!