Jsdoc: process since tag.

Author: PhaserEditor2D

scripts/whats-new-in-phaser-api.js

@@ -0,0 +1,19 @@
+#!/usr/bin/node
+
+var fs = require("fs");
+
+var jsonPath = "/home/arian/Documents/Phaser/phaser3-docs/json/phaser.json";
+
+
+fs.readFile(jsonPath, 'utf8', processFile);
+
+function processFile(err, data) {
+	var json = JSON.parse(data);
+
+	for(var entry of json.docs) {
+
+		if (entry.since) {
+			console.log(entry.since + " " + entry.longname);	
+		}		
+	}
+}

source/v2/phasereditor/phasereditor.inspect.core/src/phasereditor/inspect/core/jsdoc/IPhaserMember.java

@@ -31,6 +31,8 @@
 import phasereditor.ui.ISourceLocation;
 
 public interface IPhaserMember extends ISourceLocation, Serializable {
+	public String getSince();
+	
 	public String getName();
 
 	public String getHelp();

source/v2/phasereditor/phasereditor.inspect.core/src/phasereditor/inspect/core/jsdoc/JsdocRenderer.java

@@ -260,6 +260,7 @@ public String render(Object member) {
 		if (member instanceof PhaserVariable) {
 			return renderVariable((PhaserVariable) member);
 		}
+		
 		if (member instanceof PhaserNamespace) {
 			return renderNamespace((PhaserNamespace) member);
 		}
@@ -273,6 +274,8 @@ private String renderNamespace(PhaserNamespace member) {
 		sb.append("<b>" + renderImageBase64(getImage(member)) + " " + member.getName() + "</b>");
 
 		sb.append("<p>" + processHtmlDescription(member.getHelp()) + "</p>");
+		
+		renderSince(sb, member);
 
 		return sb.toString();
 	}
@@ -295,8 +298,10 @@ private String renderEventConstant(PhaserEventConstant event) {
 		var qname = container.getName() + "." + event.getName();
 
 		sb.append("<b>" + renderImageBase64(getImage(event)) + " event " + qname + "</b>");
-
+		
 		sb.append("<p>" + processHtmlDescription(event.getHelp()) + "</p>");
+		
+		renderSince(sb, event);
 
 		sb.append(htmlArgsDoc(event.getArgs()));
 
@@ -326,8 +331,10 @@ private String renderConstant(PhaserConstant cons) {
 		String qname = container.getName() + "." + cons.getName();
 
 		sb.append("<b>" + renderImageBase64(getImage(cons)) + returnSignature + " " + qname + "</b>");
-
+		
 		sb.append("<p>" + processHtmlDescription(cons.getHelp()) + "</p>");
+		
+		renderSince(sb, cons);
 
 		return sb.toString();
 	}
@@ -342,6 +349,8 @@ private String renderVariable(PhaserVariable var) {
 		sb.append("<b>" + renderImageBase64(getImage(var)) + returnSignature + " " + qname + "</b>");
 
 		sb.append("<p>" + processHtmlDescription(var.getHelp()) + "</p>");
+		
+		renderSince(sb, var);
 
 		if (var instanceof PhaserProperty && ((PhaserProperty) var).isReadOnly()) {
 			sb.append("<p><b>readonly</b></p>");
@@ -363,6 +372,8 @@ public String renderMethod(PhaserMethod method) {
 				+ htmlArgsList(method.getArgs()) + "</b>");
 
 		sb.append("<p>" + processHtmlDescription(method.getHelp()) + "</p>");
+		
+		renderSince(sb, method);
 
 		renderFires(sb, method);
 
@@ -401,8 +412,10 @@ public String renderType(PhaserType type) {
 			sb.append(" <b>extends</b> " + renderExtends(type));
 		}
 		sb.append("<br>");
-
+		
 		sb.append("<p>" + processHtmlDescription(type.getHelp()) + "</p>");
+		
+		renderSince(sb, type);
 
 		renderFires(sb, type);
 
@@ -411,6 +424,13 @@ public String renderType(PhaserType type) {
 		return sb.toString();
 	}
 
+	private void renderSince(StringBuilder sb, IPhaserMember member) {
+		var since = member.getSince();
+		if (since != null) {
+			sb.append("<p><b>Since</b>: " + since + "</p>");
+		}
+	}
+
 	private String renderExtends(PhaserType type) {
 		StringBuilder sb = new StringBuilder();
 		int i = 0;

source/v2/phasereditor/phasereditor.inspect.core/src/phasereditor/inspect/core/jsdoc/PhaserJsdocModel.java

@@ -67,7 +67,7 @@ public synchronized static PhaserJsdocModel getInstance() {
 
 				var size = Files.getLastModifiedTime(docsJsonFile).toMillis();
 
-				var cacheFile = InspectCore.getUserCacheFolder().resolve("phaser.json." + size + ".binary");
+				var cacheFile = InspectCore.getUserCacheFolder().resolve("phaser.json.2." + size + ".binary");
 
 				if (Files.exists(cacheFile)) {
 					try (var input = new ObjectInputStream(Files.newInputStream(cacheFile))) {
@@ -284,11 +284,21 @@ private void buildPhaserJSDoc(Path docsJsonFile) throws IOException {
 			}
 
 			{
-				// build fires
 				for (var member : _membersMap.values()) {
 					buildFiresEventList(member);
+					buildSince(member);
 				}
 			}
+
+		}
+	}
+
+	private static void buildSince(IPhaserMember member) {
+		if (member instanceof PhaserMember) {
+			var json = member.getJSON();
+			if (json.has("since")) {
+				((PhaserMember) member).setSince(json.getString("since"));
+			}
 		}
 	}
 
@@ -825,9 +835,9 @@ private void buildFiresEventList(IPhaserMember member) {
 			for (int i = 0; i < firesArray.length(); i++) {
 				var name = firesArray.getString(i);
 				name = name.replace("#event:", ".");
-				
+
 				var event = (PhaserEventConstant) _membersMap.get(name);
-				
+
 				if (event != null) {
 					member.getFiresEventList().add(event);
 				}

source/v2/phasereditor/phasereditor.inspect.core/src/phasereditor/inspect/core/jsdoc/PhaserMember.java

@@ -29,7 +29,7 @@
 
 public abstract class PhaserMember implements IPhaserMember, IAdaptable {
 
-	private static final long serialVersionUID = 2L;
+	private static final long serialVersionUID = 3L;
 
 	private String _name;
 	private String _help;
@@ -39,15 +39,24 @@ public abstract class PhaserMember implements IPhaserMember, IAdaptable {
 	private transient JSONObject _json;
 	private IMemberContainer _container;
 	private List<PhaserEventConstant> _firesEventList;
-
 	private String _filename;
+	private String _since;
 
 	public PhaserMember(JSONObject json) {
 		_static = false;
 		_json = json;
 		_firesEventList = new ArrayList<>();
 	}
 
+	@Override
+	public String getSince() {
+		return _since;
+	}
+	
+	public void setSince(String since) {
+		_since = since;
+	}
+	
 	@Override
 	public List<PhaserEventConstant> getFiresEventList() {
 		return _firesEventList;