From af94e99fc9acc905c3015ee8dd02f938ffd461b2 Mon Sep 17 00:00:00 2001
From: lionarius <main@lionarius.ru>
Date: Thu, 5 Sep 2024 10:28:32 +0300
Subject: [PATCH] add javadoc to AreaCalculator

---
 src/main/java/ru/lionarius/AreaCalculator.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/main/java/ru/lionarius/AreaCalculator.java b/src/main/java/ru/lionarius/AreaCalculator.java
index 2e1f1c1..f34f92f 100644
--- a/src/main/java/ru/lionarius/AreaCalculator.java
+++ b/src/main/java/ru/lionarius/AreaCalculator.java
@@ -1,7 +1,17 @@
 package ru.lionarius;
 
+/**
+ * A class that provides methods to calculate the area of different geometric shapes.
+ */
 public class AreaCalculator {
 
+    /**
+     * Calculates the area of a circle given its radius.
+     *
+     * @param radius The radius of the circle.
+     * @return The area of the circle.
+     * @throws IllegalArgumentException if the radius is negative.
+     */
     public double circle(double radius) {
         if (radius < 0.0)
             throw new IllegalArgumentException("radius cannot be negative");