From 8d4f608e90b176f7f47fccf213a90a560a8c87fe Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 11 May 2024 22:12:15 -0700 Subject: [PATCH 1/2] Updated copyright --- .idea/copyright/BSD_3.xml | 2 +- LICENSE.TXT | 2 +- src/bld/java/net/thauvin/erik/ReadingTimeBuild.java | 8 ++++---- src/main/kotlin/net/thauvin/erik/readingtime/Config.kt | 6 +++--- .../kotlin/net/thauvin/erik/readingtime/ReadingTime.kt | 8 ++++---- src/main/resources/META-INF/tags/readingtime.tag | 2 +- .../net/thauvin/erik/readingtime/ReadingTimeTest.kt | 8 ++++---- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.idea/copyright/BSD_3.xml b/.idea/copyright/BSD_3.xml index 2586a79..16075c3 100644 --- a/.idea/copyright/BSD_3.xml +++ b/.idea/copyright/BSD_3.xml @@ -1,6 +1,6 @@ - \ No newline at end of file diff --git a/LICENSE.TXT b/LICENSE.TXT index d8e958e..b9f50dd 100644 --- a/LICENSE.TXT +++ b/LICENSE.TXT @@ -1,4 +1,4 @@ -Copyright (c) 2020-2023, Erik C. Thauvin (erik@thauvin.net) +Copyright (c) 2020-2024, Erik C. Thauvin (erik@thauvin.net) All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/src/bld/java/net/thauvin/erik/ReadingTimeBuild.java b/src/bld/java/net/thauvin/erik/ReadingTimeBuild.java index 681b670..a432174 100644 --- a/src/bld/java/net/thauvin/erik/ReadingTimeBuild.java +++ b/src/bld/java/net/thauvin/erik/ReadingTimeBuild.java @@ -1,18 +1,18 @@ /* - * Copyright (c) 2020-2023, Erik C. Thauvin (erik@thauvin.net) + * Copyright (c) 2020-2024, Erik C. Thauvin (erik@thauvin.net) * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * - * Redistributions of source code must retain the above copyright notice, this + * Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * - * Redistributions in binary form must reproduce the above copyright notice, + * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * - * Neither the name of this project nor the names of its contributors may be + * Neither the name of this project nor the names of its contributors may be * used to endorse or promote products derived from this software without * specific prior written permission. * diff --git a/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt b/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt index bb66724..b4cad54 100644 --- a/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt +++ b/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt @@ -5,14 +5,14 @@ * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * - * Redistributions of source code must retain the above copyright notice, this + * Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * - * Redistributions in binary form must reproduce the above copyright notice, + * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * - * Neither the name of this project nor the names of its contributors may be + * Neither the name of this project nor the names of its contributors may be * used to endorse or promote products derived from this software without * specific prior written permission. * diff --git a/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt b/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt index 0f593cf..d58e161 100644 --- a/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt +++ b/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt @@ -1,18 +1,18 @@ /* - * Copyright (c) 2020-2023, Erik C. Thauvin (erik@thauvin.net) + * Copyright (c) 2020-2024, Erik C. Thauvin (erik@thauvin.net) * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * - * Redistributions of source code must retain the above copyright notice, this + * Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * - * Redistributions in binary form must reproduce the above copyright notice, + * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * - * Neither the name of this project nor the names of its contributors may be + * Neither the name of this project nor the names of its contributors may be * used to endorse or promote products derived from this software without * specific prior written permission. * diff --git a/src/main/resources/META-INF/tags/readingtime.tag b/src/main/resources/META-INF/tags/readingtime.tag index e8c3bcb..d0c0980 100644 --- a/src/main/resources/META-INF/tags/readingtime.tag +++ b/src/main/resources/META-INF/tags/readingtime.tag @@ -1,5 +1,5 @@ <%-- - Copyright (c) 2020-2023, Erik C. Thauvin (erik@thauvin.net) + Copyright (c) 2020-2024, Erik C. Thauvin (erik@thauvin.net) All rights reserved. See: https://erik.thauvin.net/licenses/bsd.shtml diff --git a/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt b/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt index 37b0ad9..2242ca8 100644 --- a/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt +++ b/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt @@ -1,18 +1,18 @@ /* - * Copyright (c) 2020-2023, Erik C. Thauvin (erik@thauvin.net) + * Copyright (c) 2020-2024, Erik C. Thauvin (erik@thauvin.net) * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * - * Redistributions of source code must retain the above copyright notice, this + * Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * - * Redistributions in binary form must reproduce the above copyright notice, + * Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * - * Neither the name of this project nor the names of its contributors may be + * Neither the name of this project nor the names of its contributors may be * used to endorse or promote products derived from this software without * specific prior written permission. * From 258b8126bb7938adb55f02de3e9f7d62a67320ac Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sun, 12 May 2024 12:08:27 -0700 Subject: [PATCH 2/2] Minor cleanups --- .idea/intellij-javadocs-4.0.1.xml | 204 ++++++++++++++++++ .idea/misc.xml | 6 + .../gradle/.idea/intellij-javadocs-4.0.1.xml | 204 ++++++++++++++++++ examples/gradle/.idea/kotlinc.xml | 2 +- examples/gradle/.idea/misc.xml | 6 +- .../net/thauvin/erik/ReadingTimeBuild.java | 11 +- 6 files changed, 427 insertions(+), 6 deletions(-) create mode 100644 .idea/intellij-javadocs-4.0.1.xml create mode 100644 examples/gradle/.idea/intellij-javadocs-4.0.1.xml diff --git a/.idea/intellij-javadocs-4.0.1.xml b/.idea/intellij-javadocs-4.0.1.xml new file mode 100644 index 0000000..3ed9781 --- /dev/null +++ b/.idea/intellij-javadocs-4.0.1.xml @@ -0,0 +1,204 @@ + + + + + UPDATE + false + true + + METHOD + TYPE + FIELD + + + DEFAULT + PUBLIC + PROTECTED + + + + + + ^.*(public|protected|private)*.+interface\s+\w+.* + /**\n + * The interface ${name}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> + */ + + + ^.*(public|protected|private)*.+enum\s+\w+.* + /**\n + * The enum ${name}.\n + */ + + + ^.*(public|protected|private)*.+class\s+\w+.* + /**\n + * The type ${name}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> + */ + + + .+ + /**\n + * The type ${name}.\n + */ + + + + + .+ + /**\n + * Instantiates a new ${name}.\n +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + + + ^.*(public|protected|private)*\s*.*(\w(\s*<.+>)*)+\s+get\w+\s*\(.*\).+ + /**\n + * Gets ${partName}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if isNotVoid> + *\n + * @return the ${partName}\n +</#if> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + ^.*(public|protected|private)*\s*.*(void|\w(\s*<.+>)*)+\s+set\w+\s*\(.*\).+ + /**\n + * Sets ${partName}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if isNotVoid> + *\n + * @return the ${partName}\n +</#if> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + ^.*((public\s+static)|(static\s+public))\s+void\s+main\s*\(\s*String\s*(\[\s*\]|\.\.\.)\s+\w+\s*\).+ + /**\n + * The entry point of application.\n + + <#if element.parameterList.parameters?has_content> + *\n +</#if> + * @param ${element.parameterList.parameters[0].name} the input arguments\n +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + .+ + /**\n + * ${name}<#if isNotVoid> ${return}</#if>.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if isNotVoid> + *\n + * @return the ${return}\n +</#if> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + + + ^.*(public|protected|private)*.+static.*(\w\s\w)+.+ + /**\n + * The constant ${element.getName()}.\n + */ + + + ^.*(public|protected|private)*.*(\w\s\w)+.+ + /**\n + <#if element.parent.isInterface()> + * The constant ${element.getName()}.\n +<#else> + * The ${name}.\n +</#if> */ + + + .+ + /**\n + <#if element.parent.isEnum()> + *${name} ${typeName}.\n +<#else> + * The ${name}.\n +</#if>*/ + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml index f206b95..96b0faa 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -16,6 +16,12 @@