Skip to content

Commit

Permalink
Update JavaDoc summary
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewDiMola authored Feb 26, 2024
1 parent 56a12e9 commit e4a99b9
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions _posts/2019-03-15-JavaDoc.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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, <a href="/samples/haystack.pdf">open the PDF</a>.

Expand Down

0 comments on commit e4a99b9

Please sign in to comment.