From 53267afa31ba00d8d02e6417919553feaa4a670f Mon Sep 17 00:00:00 2001 From: kevinstadler Date: Sun, 10 Sep 2023 01:16:39 +0200 Subject: [PATCH 1/3] Set appropriate default instance names for the 'syntax' section --- ReferenceGenerator/src/writers/BaseWriter.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/ReferenceGenerator/src/writers/BaseWriter.java b/ReferenceGenerator/src/writers/BaseWriter.java index b19c4ad..abf93a1 100644 --- a/ReferenceGenerator/src/writers/BaseWriter.java +++ b/ReferenceGenerator/src/writers/BaseWriter.java @@ -375,7 +375,11 @@ protected static String getInstanceName(Element element) { if (tags != null && tags.size() > 0) { return tags.get(0).split("\\s")[0]; } - return ""; + if (element.getModifiers().contains(Modifier.STATIC)) { + return element.getEnclosingElement().getSimpleName().toString(); + } else { + return element.getEnclosingElement().getSimpleName().toString().toLowerCase(); + } } protected static String getInstanceDescription(Element element) { @@ -387,6 +391,9 @@ protected static String getInstanceDescription(Element element) { String s = tags.get(0); return s.substring(s.indexOf(" ")); } + // if (!element.getModifiers().contains(Modifier.STATIC)) { + // return "any object of type " + element.getEnclosingElement().getSimpleName().toString(); + // } return ""; } From 5f7b6891a3f39d0112d04d0ee74aece91ad7228d Mon Sep 17 00:00:00 2001 From: kevinstadler Date: Sat, 13 Apr 2024 12:04:37 -0600 Subject: [PATCH 2/3] Update default instance name and description based on OSACC discussion --- .../src/writers/BaseWriter.java | 28 +++++++++++-------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/ReferenceGenerator/src/writers/BaseWriter.java b/ReferenceGenerator/src/writers/BaseWriter.java index abf93a1..8ad7264 100644 --- a/ReferenceGenerator/src/writers/BaseWriter.java +++ b/ReferenceGenerator/src/writers/BaseWriter.java @@ -368,17 +368,23 @@ protected static String getUsage(Element element) { } protected static String getInstanceName(Element element) { - List tags = Shared - .i() - .getTags(element.getEnclosingElement()) - .get("instanceName"); - if (tags != null && tags.size() > 0) { - return tags.get(0).split("\\s")[0]; - } if (element.getModifiers().contains(Modifier.STATIC)) { + // always use original class name for static methods return element.getEnclosingElement().getSimpleName().toString(); } else { - return element.getEnclosingElement().getSimpleName().toString().toLowerCase(); + // TODO add some coloration and/or italics around the instance name to + // signify "this can/needs to be changed" + List tags = Shared + .i() + .getTags(element.getEnclosingElement()) + .get("instanceName"); + if (tags != null && tags.size() > 0) { + // use the javadoc @instanceName if there is one + return tags.get(0).split("\\s")[0]; + } else { + // if none, default to "myClassName" + return "my" + element.getEnclosingElement().getSimpleName().toString(); + } } } @@ -391,9 +397,9 @@ protected static String getInstanceDescription(Element element) { String s = tags.get(0); return s.substring(s.indexOf(" ")); } - // if (!element.getModifiers().contains(Modifier.STATIC)) { - // return "any object of type " + element.getEnclosingElement().getSimpleName().toString(); - // } + if (!element.getModifiers().contains(Modifier.STATIC)) { + return "any variable of type " + element.getEnclosingElement().getSimpleName().toString(); + } return ""; } From b197e1c5055feaf0a5fdd8322f3da8c9f5f865a4 Mon Sep 17 00:00:00 2001 From: kevinstadler Date: Sat, 13 Apr 2024 16:52:48 -0600 Subject: [PATCH 3/3] Avoid jargon in default instance description (thanks @nickmcintyre!) --- ReferenceGenerator/src/writers/BaseWriter.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ReferenceGenerator/src/writers/BaseWriter.java b/ReferenceGenerator/src/writers/BaseWriter.java index 8ad7264..211cf9b 100644 --- a/ReferenceGenerator/src/writers/BaseWriter.java +++ b/ReferenceGenerator/src/writers/BaseWriter.java @@ -398,7 +398,7 @@ protected static String getInstanceDescription(Element element) { return s.substring(s.indexOf(" ")); } if (!element.getModifiers().contains(Modifier.STATIC)) { - return "any variable of type " + element.getEnclosingElement().getSimpleName().toString(); + return "your " + element.getEnclosingElement().getSimpleName().toString() + " object"; } return ""; }