From f1706930d6fd619795cee9c93f085a1dae19675f Mon Sep 17 00:00:00 2001 From: Thijs Kamphuis Date: Tue, 28 Jan 2025 01:15:18 +0100 Subject: [PATCH] pp --- docs/html/annotated.html | 80 +++++ docs/html/classes.html | 80 +++++ .../html/classtest_1_1Calculator-members.html | 88 ++++++ docs/html/classtest_1_1Calculator.html | 292 ++++++++++++++++++ .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 78 +++++ docs/html/functions.html | 90 ++++++ docs/html/functions_func.html | 90 ++++++ docs/html/menudata.js | 8 +- docs/html/search/all_0.html | 37 +++ docs/html/search/all_0.js | 4 + docs/html/search/all_1.html | 37 +++ docs/html/search/all_1.js | 4 + docs/html/search/all_2.html | 37 +++ docs/html/search/all_2.js | 5 + docs/html/search/all_3.html | 37 +++ docs/html/search/all_3.js | 4 + docs/html/search/all_4.html | 37 +++ docs/html/search/all_4.js | 4 + docs/html/search/all_5.html | 37 +++ docs/html/search/all_5.js | 4 + docs/html/search/classes_0.html | 37 +++ docs/html/search/classes_0.js | 4 + docs/html/search/functions_0.html | 37 +++ docs/html/search/functions_0.js | 4 + docs/html/search/functions_1.html | 37 +++ docs/html/search/functions_1.js | 4 + docs/html/search/functions_2.html | 37 +++ docs/html/search/functions_2.js | 4 + docs/html/search/functions_3.html | 37 +++ docs/html/search/functions_3.js | 4 + docs/html/search/functions_4.html | 37 +++ docs/html/search/functions_4.js | 4 + docs/html/search/functions_5.html | 37 +++ docs/html/search/functions_5.js | 4 + docs/html/search/searchdata.js | 9 + docs/latex/annotated.tex | 4 + docs/latex/classtest_1_1Calculator.tex | 104 +++++++ docs/latex/refman.tex | 4 + test.py => src/test.py | 0 39 files changed, 1460 insertions(+), 1 deletion(-) create mode 100644 docs/html/annotated.html create mode 100644 docs/html/classes.html create mode 100644 docs/html/classtest_1_1Calculator-members.html create mode 100644 docs/html/classtest_1_1Calculator.html create mode 100644 docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html create mode 100644 docs/html/functions.html create mode 100644 docs/html/functions_func.html create mode 100644 docs/html/search/all_0.html create mode 100644 docs/html/search/all_0.js create mode 100644 docs/html/search/all_1.html create mode 100644 docs/html/search/all_1.js create mode 100644 docs/html/search/all_2.html create mode 100644 docs/html/search/all_2.js create mode 100644 docs/html/search/all_3.html create mode 100644 docs/html/search/all_3.js create mode 100644 docs/html/search/all_4.html create mode 100644 docs/html/search/all_4.js create mode 100644 docs/html/search/all_5.html create mode 100644 docs/html/search/all_5.js create mode 100644 docs/html/search/classes_0.html create mode 100644 docs/html/search/classes_0.js create mode 100644 docs/html/search/functions_0.html create mode 100644 docs/html/search/functions_0.js create mode 100644 docs/html/search/functions_1.html create mode 100644 docs/html/search/functions_1.js create mode 100644 docs/html/search/functions_2.html create mode 100644 docs/html/search/functions_2.js create mode 100644 docs/html/search/functions_3.html create mode 100644 docs/html/search/functions_3.js create mode 100644 docs/html/search/functions_4.html create mode 100644 docs/html/search/functions_4.js create mode 100644 docs/html/search/functions_5.html create mode 100644 docs/html/search/functions_5.js create mode 100644 docs/latex/annotated.tex create mode 100644 docs/latex/classtest_1_1Calculator.tex rename test.py => src/test.py (100%) diff --git a/docs/html/annotated.html b/docs/html/annotated.html new file mode 100644 index 0000000..26c737c --- /dev/null +++ b/docs/html/annotated.html @@ -0,0 +1,80 @@ + + + + + + + +Doxytest: Class List + + + + + + + + + +
+
+ + + + + + +
+
Doxytest +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 12]
+ + +
 ▼Ntest
 CCalculator
+
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classes.html b/docs/html/classes.html new file mode 100644 index 0000000..7adeae2 --- /dev/null +++ b/docs/html/classes.html @@ -0,0 +1,80 @@ + + + + + + + +Doxytest: Class Index + + + + + + + + + +
+
+ + + + + + +
+
Doxytest +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+
Class Index
+
+
+
C
+
+
+
C
+
Calculator (test)
+
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classtest_1_1Calculator-members.html b/docs/html/classtest_1_1Calculator-members.html new file mode 100644 index 0000000..2874eaa --- /dev/null +++ b/docs/html/classtest_1_1Calculator-members.html @@ -0,0 +1,88 @@ + + + + + + + +Doxytest: Member List + + + + + + + + + +
+
+ + + + + + +
+
Doxytest +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
test.Calculator Member List
+
+
+ +

This is the complete list of members for test.Calculator, including all inherited members.

+ + + + + + + + +
__init__(self, value=0)test.Calculator
add(self, number)test.Calculator
clear(self)test.Calculator
divide(self, number)test.Calculator
multiply(self, number)test.Calculator
subtract(self, number)test.Calculator
value (defined in test.Calculator)test.Calculator
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classtest_1_1Calculator.html b/docs/html/classtest_1_1Calculator.html new file mode 100644 index 0000000..1ee6a77 --- /dev/null +++ b/docs/html/classtest_1_1Calculator.html @@ -0,0 +1,292 @@ + + + + + + + +Doxytest: test.Calculator Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Doxytest +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
test.Calculator Class Reference
+
+
+ + + + + + + + + + + + + + +

+Public Member Functions

def __init__ (self, value=0)
 
def add (self, number)
 
def subtract (self, number)
 
def multiply (self, number)
 
def divide (self, number)
 
def clear (self)
 
+ + + +

+Public Attributes

+ value
 
+

Detailed Description

+
A simple calculator class to perform basic arithmetic operations.
+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def test.Calculator.__init__ ( self,
 value = 0 
)
+
+
Initializes the calculator with a starting value.
+
+:param value: The starting value of the calculator (default is 0).
+
+
+
+

Member Function Documentation

+ +

◆ add()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def test.Calculator.add ( self,
 number 
)
+
+
Adds a number to the current value.
+
+:param number: The number to add.
+:return: The updated value after addition.
+
+
+
+ +

◆ clear()

+ +
+
+ + + + + + + + +
def test.Calculator.clear ( self)
+
+
Resets the calculator to its initial value (0).
+
+:return: The reset value (0).
+
+
+
+ +

◆ divide()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def test.Calculator.divide ( self,
 number 
)
+
+
Divides the current value by the given number.
+
+:param number: The number to divide by.
+:return: The updated value after division.
+:raises ZeroDivisionError: If the number is zero.
+
+
+
+ +

◆ multiply()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def test.Calculator.multiply ( self,
 number 
)
+
+
Multiplies the current value by a given number.
+
+:param number: The number to multiply with.
+:return: The updated value after multiplication.
+
+
+
+ +

◆ subtract()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def test.Calculator.subtract ( self,
 number 
)
+
+
Subtracts a number from the current value.
+
+:param number: The number to subtract.
+:return: The updated value after subtraction.
+
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html new file mode 100644 index 0000000..fd79c6c --- /dev/null +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -0,0 +1,78 @@ + + + + + + + +Doxytest: src Directory Reference + + + + + + + + + +
+
+ + + + + + +
+
Doxytest +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
src Directory Reference
+
+
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/functions.html b/docs/html/functions.html new file mode 100644 index 0000000..0146b01 --- /dev/null +++ b/docs/html/functions.html @@ -0,0 +1,90 @@ + + + + + + + +Doxytest: Class Members + + + + + + + + + +
+
+ + + + + + +
+
Doxytest +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html new file mode 100644 index 0000000..f5012f7 --- /dev/null +++ b/docs/html/functions_func.html @@ -0,0 +1,90 @@ + + + + + + + +Doxytest: Class Members - Functions + + + + + + + + + +
+
+ + + + + + +
+
Doxytest +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+  +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/menudata.js b/docs/html/menudata.js index d1ece13..4969afb 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -23,4 +23,10 @@ @licend The above is the entire license notice for the JavaScript code in this file */ var menudata={children:[ -{text:"Main Page",url:"index.html"}]} +{text:"Main Page",url:"index.html"}, +{text:"Classes",url:"annotated.html",children:[ +{text:"Class List",url:"annotated.html"}, +{text:"Class Index",url:"classes.html"}, +{text:"Class Members",url:"functions.html",children:[ +{text:"All",url:"functions.html"}, +{text:"Functions",url:"functions_func.html"}]}]}]} diff --git a/docs/html/search/all_0.html b/docs/html/search/all_0.html new file mode 100644 index 0000000..1ec5b2d --- /dev/null +++ b/docs/html/search/all_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js new file mode 100644 index 0000000..b642ffd --- /dev/null +++ b/docs/html/search/all_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['_5f_5finit_5f_5f_0',['__init__',['../classtest_1_1Calculator.html#a350c5ee9551106bcadf487abe983f1ce',1,'test::Calculator']]] +]; diff --git a/docs/html/search/all_1.html b/docs/html/search/all_1.html new file mode 100644 index 0000000..9f80e90 --- /dev/null +++ b/docs/html/search/all_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js new file mode 100644 index 0000000..6e766ff --- /dev/null +++ b/docs/html/search/all_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['add_1',['add',['../classtest_1_1Calculator.html#a3b0de864b2501e6cbe51d374023d9485',1,'test::Calculator']]] +]; diff --git a/docs/html/search/all_2.html b/docs/html/search/all_2.html new file mode 100644 index 0000000..02cfffc --- /dev/null +++ b/docs/html/search/all_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js new file mode 100644 index 0000000..bab5ed3 --- /dev/null +++ b/docs/html/search/all_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['calculator_2',['Calculator',['../classtest_1_1Calculator.html',1,'test']]], + ['clear_3',['clear',['../classtest_1_1Calculator.html#aef3f4068440573b93e3c5fb556964223',1,'test::Calculator']]] +]; diff --git a/docs/html/search/all_3.html b/docs/html/search/all_3.html new file mode 100644 index 0000000..39767b8 --- /dev/null +++ b/docs/html/search/all_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js new file mode 100644 index 0000000..7d9c233 --- /dev/null +++ b/docs/html/search/all_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['divide_4',['divide',['../classtest_1_1Calculator.html#a39ad2dc1258dd50fd2970d7627f14219',1,'test::Calculator']]] +]; diff --git a/docs/html/search/all_4.html b/docs/html/search/all_4.html new file mode 100644 index 0000000..fc40463 --- /dev/null +++ b/docs/html/search/all_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js new file mode 100644 index 0000000..53d38bd --- /dev/null +++ b/docs/html/search/all_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['multiply_5',['multiply',['../classtest_1_1Calculator.html#a4ebb4c4221c4e2b12dc417a1704dc79b',1,'test::Calculator']]] +]; diff --git a/docs/html/search/all_5.html b/docs/html/search/all_5.html new file mode 100644 index 0000000..9dd9344 --- /dev/null +++ b/docs/html/search/all_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/all_5.js b/docs/html/search/all_5.js new file mode 100644 index 0000000..634cb27 --- /dev/null +++ b/docs/html/search/all_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['subtract_6',['subtract',['../classtest_1_1Calculator.html#a398ce099422193d3a814a23df307af40',1,'test::Calculator']]] +]; diff --git a/docs/html/search/classes_0.html b/docs/html/search/classes_0.html new file mode 100644 index 0000000..af8159e --- /dev/null +++ b/docs/html/search/classes_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/classes_0.js b/docs/html/search/classes_0.js new file mode 100644 index 0000000..d46c0bc --- /dev/null +++ b/docs/html/search/classes_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['calculator_7',['Calculator',['../classtest_1_1Calculator.html',1,'test']]] +]; diff --git a/docs/html/search/functions_0.html b/docs/html/search/functions_0.html new file mode 100644 index 0000000..eb4c501 --- /dev/null +++ b/docs/html/search/functions_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/functions_0.js b/docs/html/search/functions_0.js new file mode 100644 index 0000000..4c85ed8 --- /dev/null +++ b/docs/html/search/functions_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['_5f_5finit_5f_5f_8',['__init__',['../classtest_1_1Calculator.html#a350c5ee9551106bcadf487abe983f1ce',1,'test::Calculator']]] +]; diff --git a/docs/html/search/functions_1.html b/docs/html/search/functions_1.html new file mode 100644 index 0000000..ef4088b --- /dev/null +++ b/docs/html/search/functions_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/functions_1.js b/docs/html/search/functions_1.js new file mode 100644 index 0000000..ae7c9ca --- /dev/null +++ b/docs/html/search/functions_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['add_9',['add',['../classtest_1_1Calculator.html#a3b0de864b2501e6cbe51d374023d9485',1,'test::Calculator']]] +]; diff --git a/docs/html/search/functions_2.html b/docs/html/search/functions_2.html new file mode 100644 index 0000000..ca5aa10 --- /dev/null +++ b/docs/html/search/functions_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js new file mode 100644 index 0000000..4689a82 --- /dev/null +++ b/docs/html/search/functions_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['clear_10',['clear',['../classtest_1_1Calculator.html#aef3f4068440573b93e3c5fb556964223',1,'test::Calculator']]] +]; diff --git a/docs/html/search/functions_3.html b/docs/html/search/functions_3.html new file mode 100644 index 0000000..d79f55b --- /dev/null +++ b/docs/html/search/functions_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/functions_3.js b/docs/html/search/functions_3.js new file mode 100644 index 0000000..4088868 --- /dev/null +++ b/docs/html/search/functions_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['divide_11',['divide',['../classtest_1_1Calculator.html#a39ad2dc1258dd50fd2970d7627f14219',1,'test::Calculator']]] +]; diff --git a/docs/html/search/functions_4.html b/docs/html/search/functions_4.html new file mode 100644 index 0000000..1657cad --- /dev/null +++ b/docs/html/search/functions_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/functions_4.js b/docs/html/search/functions_4.js new file mode 100644 index 0000000..759922d --- /dev/null +++ b/docs/html/search/functions_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['multiply_12',['multiply',['../classtest_1_1Calculator.html#a4ebb4c4221c4e2b12dc417a1704dc79b',1,'test::Calculator']]] +]; diff --git a/docs/html/search/functions_5.html b/docs/html/search/functions_5.html new file mode 100644 index 0000000..9301d6b --- /dev/null +++ b/docs/html/search/functions_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/functions_5.js b/docs/html/search/functions_5.js new file mode 100644 index 0000000..13dd32c --- /dev/null +++ b/docs/html/search/functions_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['subtract_13',['subtract',['../classtest_1_1Calculator.html#a398ce099422193d3a814a23df307af40',1,'test::Calculator']]] +]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index f95870c..c0e0eac 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,12 +1,21 @@ var indexSectionsWithContent = { + 0: "_acdms", + 1: "c", + 2: "_acdms" }; var indexSectionNames = { + 0: "all", + 1: "classes", + 2: "functions" }; var indexSectionLabels = { + 0: "All", + 1: "Classes", + 2: "Functions" }; diff --git a/docs/latex/annotated.tex b/docs/latex/annotated.tex new file mode 100644 index 0000000..022ffb3 --- /dev/null +++ b/docs/latex/annotated.tex @@ -0,0 +1,4 @@ +\doxysection{Class List} +Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList} +\item\contentsline{section}{\mbox{\hyperlink{classtest_1_1Calculator}{test.\+Calculator}} }{\pageref{classtest_1_1Calculator}}{} +\end{DoxyCompactList} diff --git a/docs/latex/classtest_1_1Calculator.tex b/docs/latex/classtest_1_1Calculator.tex new file mode 100644 index 0000000..f6eabc6 --- /dev/null +++ b/docs/latex/classtest_1_1Calculator.tex @@ -0,0 +1,104 @@ +\hypertarget{classtest_1_1Calculator}{}\doxysection{test.\+Calculator Class Reference} +\label{classtest_1_1Calculator}\index{test.Calculator@{test.Calculator}} +\doxysubsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +def \mbox{\hyperlink{classtest_1_1Calculator_a350c5ee9551106bcadf487abe983f1ce}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, value=0) +\item +def \mbox{\hyperlink{classtest_1_1Calculator_a3b0de864b2501e6cbe51d374023d9485}{add}} (self, number) +\item +def \mbox{\hyperlink{classtest_1_1Calculator_a398ce099422193d3a814a23df307af40}{subtract}} (self, number) +\item +def \mbox{\hyperlink{classtest_1_1Calculator_a4ebb4c4221c4e2b12dc417a1704dc79b}{multiply}} (self, number) +\item +def \mbox{\hyperlink{classtest_1_1Calculator_a39ad2dc1258dd50fd2970d7627f14219}{divide}} (self, number) +\item +def \mbox{\hyperlink{classtest_1_1Calculator_aef3f4068440573b93e3c5fb556964223}{clear}} (self) +\end{DoxyCompactItemize} +\doxysubsection*{Public Attributes} +\begin{DoxyCompactItemize} +\item +\mbox{\Hypertarget{classtest_1_1Calculator_ab35d98546e4ad522f5b85254c435e7ae}\label{classtest_1_1Calculator_ab35d98546e4ad522f5b85254c435e7ae}} +{\bfseries value} +\end{DoxyCompactItemize} + + +\doxysubsection{Detailed Description} +\begin{DoxyVerb}A simple calculator class to perform basic arithmetic operations. +\end{DoxyVerb} + + +\doxysubsection{Constructor \& Destructor Documentation} +\mbox{\Hypertarget{classtest_1_1Calculator_a350c5ee9551106bcadf487abe983f1ce}\label{classtest_1_1Calculator_a350c5ee9551106bcadf487abe983f1ce}} +\index{test.Calculator@{test.Calculator}!\_\_init\_\_@{\_\_init\_\_}} +\index{\_\_init\_\_@{\_\_init\_\_}!test.Calculator@{test.Calculator}} +\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}} +{\footnotesize\ttfamily def test.\+Calculator.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{value = {\ttfamily 0} }\end{DoxyParamCaption})} + +\begin{DoxyVerb}Initializes the calculator with a starting value. + +:param value: The starting value of the calculator (default is 0). +\end{DoxyVerb} + + +\doxysubsection{Member Function Documentation} +\mbox{\Hypertarget{classtest_1_1Calculator_a3b0de864b2501e6cbe51d374023d9485}\label{classtest_1_1Calculator_a3b0de864b2501e6cbe51d374023d9485}} +\index{test.Calculator@{test.Calculator}!add@{add}} +\index{add@{add}!test.Calculator@{test.Calculator}} +\doxysubsubsection{\texorpdfstring{add()}{add()}} +{\footnotesize\ttfamily def test.\+Calculator.\+add (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})} + +\begin{DoxyVerb}Adds a number to the current value. + +:param number: The number to add. +:return: The updated value after addition. +\end{DoxyVerb} + \mbox{\Hypertarget{classtest_1_1Calculator_aef3f4068440573b93e3c5fb556964223}\label{classtest_1_1Calculator_aef3f4068440573b93e3c5fb556964223}} +\index{test.Calculator@{test.Calculator}!clear@{clear}} +\index{clear@{clear}!test.Calculator@{test.Calculator}} +\doxysubsubsection{\texorpdfstring{clear()}{clear()}} +{\footnotesize\ttfamily def test.\+Calculator.\+clear (\begin{DoxyParamCaption}\item[{}]{self }\end{DoxyParamCaption})} + +\begin{DoxyVerb}Resets the calculator to its initial value (0). + +:return: The reset value (0). +\end{DoxyVerb} + \mbox{\Hypertarget{classtest_1_1Calculator_a39ad2dc1258dd50fd2970d7627f14219}\label{classtest_1_1Calculator_a39ad2dc1258dd50fd2970d7627f14219}} +\index{test.Calculator@{test.Calculator}!divide@{divide}} +\index{divide@{divide}!test.Calculator@{test.Calculator}} +\doxysubsubsection{\texorpdfstring{divide()}{divide()}} +{\footnotesize\ttfamily def test.\+Calculator.\+divide (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})} + +\begin{DoxyVerb}Divides the current value by the given number. + +:param number: The number to divide by. +:return: The updated value after division. +:raises ZeroDivisionError: If the number is zero. +\end{DoxyVerb} + \mbox{\Hypertarget{classtest_1_1Calculator_a4ebb4c4221c4e2b12dc417a1704dc79b}\label{classtest_1_1Calculator_a4ebb4c4221c4e2b12dc417a1704dc79b}} +\index{test.Calculator@{test.Calculator}!multiply@{multiply}} +\index{multiply@{multiply}!test.Calculator@{test.Calculator}} +\doxysubsubsection{\texorpdfstring{multiply()}{multiply()}} +{\footnotesize\ttfamily def test.\+Calculator.\+multiply (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})} + +\begin{DoxyVerb}Multiplies the current value by a given number. + +:param number: The number to multiply with. +:return: The updated value after multiplication. +\end{DoxyVerb} + \mbox{\Hypertarget{classtest_1_1Calculator_a398ce099422193d3a814a23df307af40}\label{classtest_1_1Calculator_a398ce099422193d3a814a23df307af40}} +\index{test.Calculator@{test.Calculator}!subtract@{subtract}} +\index{subtract@{subtract}!test.Calculator@{test.Calculator}} +\doxysubsubsection{\texorpdfstring{subtract()}{subtract()}} +{\footnotesize\ttfamily def test.\+Calculator.\+subtract (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})} + +\begin{DoxyVerb}Subtracts a number from the current value. + +:param number: The number to subtract. +:return: The updated value after subtraction. +\end{DoxyVerb} + + +The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} +\item +src/test.\+py\end{DoxyCompactItemize} diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index f8e09c4..4c39fd2 100644 --- a/docs/latex/refman.tex +++ b/docs/latex/refman.tex @@ -171,6 +171,10 @@ \hypersetup{pageanchor=true} %--- Begin generated contents --- +\chapter{Class Index} +\input{annotated} +\chapter{Class Documentation} +\input{classtest_1_1Calculator} %--- End generated contents --- % Index diff --git a/test.py b/src/test.py similarity index 100% rename from test.py rename to src/test.py