From e4a99b9e856671b2388cc32cde6c29508bdc8923 Mon Sep 17 00:00:00 2001 From: Andrew Date: Mon, 26 Feb 2024 01:04:56 -0500 Subject: [PATCH] Update JavaDoc summary --- _posts/2019-03-15-JavaDoc.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/_posts/2019-03-15-JavaDoc.markdown b/_posts/2019-03-15-JavaDoc.markdown index da8464e..7a6f151 100644 --- a/_posts/2019-03-15-JavaDoc.markdown +++ b/_posts/2019-03-15-JavaDoc.markdown @@ -2,10 +2,11 @@ layout: post title: "Example JavaDoc" --- -This document demonstrates how a Java programmer would call a Java method named findNeedles. +This document demonstrates how a Java programmer would call a Java method named `findNeedles`. I generated it using Java SE 11 with a tool called javadoc. -Basically, at runtime, javadoc searches for various tags that a developer or technical writer embeds in Java source code, then it uses those tags to dynamically generate documentation. -I also included instructions for how the method works on the page. + +At runtime, javadoc searches for various tags that a developer or technical writer embeds in Java source code, then it uses those tags to dynamically generate documentation. +I included instructions that explain how to use the method on the page. To view this JavaDoc, open the PDF.