GNOME.org
 

[gnome-calculator] GCalc: adding classes documentation

commit 890a3cefb3caafae6b3d02d55b9b7b89fecdf766
Author: Daniel Espinosa <esodan gmail com>
Date:   Thu Oct 17 13:51:07 2019 -0500

    GCalc: adding classes documentation

 gcalc/gcalc-assign.vala               | 3 +++
 gcalc/gcalc-constant.vala             | 3 +++
 gcalc/gcalc-division.vala             | 3 +++
 gcalc/gcalc-equation-manager.vala     | 3 +++
 gcalc/gcalc-equation.vala             | 3 +++
 gcalc/gcalc-error-result.vala         | 3 +++
 gcalc/gcalc-expression-container.vala | 3 +++
 gcalc/gcalc-expression-hash-map.vala  | 3 +++
 gcalc/gcalc-expression.vala           | 7 ++++++-
 gcalc/gcalc-function-acosh.vala       | 3 +++
 gcalc/gcalc-function-asin.vala        | 3 +++
 gcalc/gcalc-function-asinh.vala       | 3 +++
 gcalc/gcalc-function-atan.vala        | 3 +++
 gcalc/gcalc-function-atanh.vala       | 3 +++
 gcalc/gcalc-function-cos.vala         | 3 +++
 gcalc/gcalc-function-cosh.vala        | 3 +++
 gcalc/gcalc-function-exp.vala         | 4 ++++
 gcalc/gcalc-function-log.vala         | 3 +++
 gcalc/gcalc-function-sin.vala         | 3 +++
 gcalc/gcalc-function-sinh.vala        | 3 +++
 gcalc/gcalc-function-sqrt.vala        | 3 +++
 gcalc/gcalc-function-tan.vala         | 3 +++
 gcalc/gcalc-function-tanh.vala        | 3 +++
 gcalc/gcalc-function.vala             | 3 +++
 gcalc/gcalc-group.vala                | 3 +++
 gcalc/gcalc-minus.vala                | 3 +++
 gcalc/gcalc-multiply.vala             | 3 +++
 gcalc/gcalc-parameter.vala            | 3 +++
 gcalc/gcalc-plus.vala                 | 3 +++
 gcalc/gcalc-polynomial.vala           | 3 +++
 gcalc/gcalc-pow.vala                  | 3 +++
 gcalc/gcalc-result.vala               | 3 +++
 gcalc/gcalc-term.vala                 | 3 +++
 gcalc/gcalc-variable.vala             | 3 +++
 34 files changed, 106 insertions(+), 1 deletion(-)
---
diff --git a/gcalc/gcalc-assign.vala b/gcalc/gcalc-assign.vala
index 04a62f7c..6b3a31de 100644
--- a/gcalc/gcalc-assign.vala
+++ b/gcalc/gcalc-assign.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathAssign}
+ */
 public class GCalc.Assign : Expression, MathOperator, MathBinaryOperator, MathAssign {
   internal override string to_string () {
     if (expressions.get_n_items () != 2) {
diff --git a/gcalc/gcalc-constant.vala b/gcalc/gcalc-constant.vala
index 0229d468..7a85aa13 100644
--- a/gcalc/gcalc-constant.vala
+++ b/gcalc/gcalc-constant.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathConstant}
+ */
 public class GCalc.Constant : Expression, MathConstant {
   private MPC.Complex _complex = MPC.Complex (1000);
 
diff --git a/gcalc/gcalc-division.vala b/gcalc/gcalc-division.vala
index 73bbd345..b67a3ce9 100644
--- a/gcalc/gcalc-division.vala
+++ b/gcalc/gcalc-division.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathDivision}
+ */
 public class GCalc.Division : Expression, MathOperator, MathBinaryOperator, MathDivision {
   internal override string to_string () {
     return "/";
diff --git a/gcalc/gcalc-equation-manager.vala b/gcalc/gcalc-equation-manager.vala
index 243c044a..022b4690 100644
--- a/gcalc/gcalc-equation-manager.vala
+++ b/gcalc/gcalc-equation-manager.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathEquationManager}
+ */
 public class GCalc.EquationManager : Object, MathEquationManager {
   ExpressionContainer _equations = new ExpressionContainer ();
   ExpressionContainer _functions = new ExpressionContainer ();
diff --git a/gcalc/gcalc-equation.vala b/gcalc/gcalc-equation.vala
index f212bcd3..6e627979 100644
--- a/gcalc/gcalc-equation.vala
+++ b/gcalc/gcalc-equation.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathEquation}
+ */
 public class GCalc.Equation : Expression, MathEquation {
   ExpressionHashMap _variables = new ExpressionHashMap ();
   internal ExpressionHashMap variables { get { return _variables; } }
diff --git a/gcalc/gcalc-error-result.vala b/gcalc/gcalc-error-result.vala
index 6ca23eb3..2fcc0c44 100644
--- a/gcalc/gcalc-error-result.vala
+++ b/gcalc/gcalc-error-result.vala
@@ -21,6 +21,9 @@
 /**
  * An implementation of {@link MathErrorResult}
  */
+/**
+ * An implementation of {@link MathErrorResult}
+ */
 public class GCalc.ErrorResult : Object, MathResult, MathErrorResult {
   private string msg = "";
   private MathExpression _expression;
diff --git a/gcalc/gcalc-expression-container.vala b/gcalc/gcalc-expression-container.vala
index 5458f81b..dc151207 100644
--- a/gcalc/gcalc-expression-container.vala
+++ b/gcalc/gcalc-expression-container.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An expression container implementing {@link GLib.ListModel}
+ */
 public class GCalc.ExpressionContainer : Gee.ArrayList<MathExpression>, GLib.ListModel {
   public weak MathExpression parent { get; set; }
 
diff --git a/gcalc/gcalc-expression-hash-map.vala b/gcalc/gcalc-expression-hash-map.vala
index 9b93c9cf..6ea934da 100644
--- a/gcalc/gcalc-expression-hash-map.vala
+++ b/gcalc/gcalc-expression-hash-map.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * A hash table using {@link Hashable} objects
+ */
 public class GCalc.ExpressionHashMap : Gee.HashMap<uint,MathExpression> {
   public weak MathExpression parent { get; set; }
 
diff --git a/gcalc/gcalc-expression.vala b/gcalc/gcalc-expression.vala
index a3b9547f..3e086039 100644
--- a/gcalc/gcalc-expression.vala
+++ b/gcalc/gcalc-expression.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathExpression}
+ */
 public class GCalc.Expression : Object, MathExpression {
   ExpressionContainer exps = new ExpressionContainer ();
   construct {
@@ -38,6 +41,8 @@ public class GCalc.Expression : Object, MathExpression {
   }
 }
 
-
+/**
+ * An implementation of {@link ErrorExpression}
+ */
 public class GCalc.GErrorExpression : Expression, ErrorExpression {}
 
diff --git a/gcalc/gcalc-function-acosh.vala b/gcalc/gcalc-function-acosh.vala
index 70a00726..ebb1a337 100644
--- a/gcalc/gcalc-function-acosh.vala
+++ b/gcalc/gcalc-function-acosh.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate arc hyperbolic cosine of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionAcosh : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-asin.vala b/gcalc/gcalc-function-asin.vala
index 114af807..bcbbefba 100644
--- a/gcalc/gcalc-function-asin.vala
+++ b/gcalc/gcalc-function-asin.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate arc sine of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionAsin : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-asinh.vala b/gcalc/gcalc-function-asinh.vala
index c6361976..334bdf5d 100644
--- a/gcalc/gcalc-function-asinh.vala
+++ b/gcalc/gcalc-function-asinh.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate arc hyperbolic sine of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionAsinh : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-atan.vala b/gcalc/gcalc-function-atan.vala
index 0e8ab4d4..959811f9 100644
--- a/gcalc/gcalc-function-atan.vala
+++ b/gcalc/gcalc-function-atan.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate arc tangent of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionAtan : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-atanh.vala b/gcalc/gcalc-function-atanh.vala
index add4848e..e247eb63 100644
--- a/gcalc/gcalc-function-atanh.vala
+++ b/gcalc/gcalc-function-atanh.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate arc hyperbolic tangent of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionAtanh : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-cos.vala b/gcalc/gcalc-function-cos.vala
index d1e3db1f..a0c15f21 100644
--- a/gcalc/gcalc-function-cos.vala
+++ b/gcalc/gcalc-function-cos.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate cosine of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionCos : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-cosh.vala b/gcalc/gcalc-function-cosh.vala
index 33483ce1..d3589492 100644
--- a/gcalc/gcalc-function-cosh.vala
+++ b/gcalc/gcalc-function-cosh.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate hyperbolic cosine of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionCosh : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-exp.vala b/gcalc/gcalc-function-exp.vala
index 8474b6ea..3aaae225 100644
--- a/gcalc/gcalc-function-exp.vala
+++ b/gcalc/gcalc-function-exp.vala
@@ -18,6 +18,10 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+
+/**
+ * Function to calculate inverse of logarithm of a {@link MathConstant}
+ */
 public class GCalc.FunctionExp : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-log.vala b/gcalc/gcalc-function-log.vala
index e33f892d..bf93e7f3 100644
--- a/gcalc/gcalc-function-log.vala
+++ b/gcalc/gcalc-function-log.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate logarithm of a {@link MathConstant}
+ */
 public class GCalc.FunctionLog : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-sin.vala b/gcalc/gcalc-function-sin.vala
index c0d033e7..35469afd 100644
--- a/gcalc/gcalc-function-sin.vala
+++ b/gcalc/gcalc-function-sin.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate sine of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionSin : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-sinh.vala b/gcalc/gcalc-function-sinh.vala
index e7dcc9e8..2cf2e7ed 100644
--- a/gcalc/gcalc-function-sinh.vala
+++ b/gcalc/gcalc-function-sinh.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate hyperbolic sine of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionSinh : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-sqrt.vala b/gcalc/gcalc-function-sqrt.vala
index fd904628..c398d70e 100644
--- a/gcalc/gcalc-function-sqrt.vala
+++ b/gcalc/gcalc-function-sqrt.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate square root of a {@link MathConstant}
+ */
 public class GCalc.FunctionSqrt : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-tan.vala b/gcalc/gcalc-function-tan.vala
index 3555e216..5f7a3113 100644
--- a/gcalc/gcalc-function-tan.vala
+++ b/gcalc/gcalc-function-tan.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate tangent of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionTan : Function {
 
   construct {
diff --git a/gcalc/gcalc-function-tanh.vala b/gcalc/gcalc-function-tanh.vala
index 189fcafd..17cd75e6 100644
--- a/gcalc/gcalc-function-tanh.vala
+++ b/gcalc/gcalc-function-tanh.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * Function to calculate hyperbolic tangent of a {@link MathConstant} in radians
+ */
 public class GCalc.FunctionTanh : Function {
 
   construct {
diff --git a/gcalc/gcalc-function.vala b/gcalc/gcalc-function.vala
index 1c07cd97..46c71ef6 100644
--- a/gcalc/gcalc-function.vala
+++ b/gcalc/gcalc-function.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathFunction}
+ */
 public class GCalc.Function : Expression, MathFunction, Hashable {
   ExpressionContainer _param_types = new ExpressionContainer ();
 
diff --git a/gcalc/gcalc-group.vala b/gcalc/gcalc-group.vala
index 5ad24422..6d948d13 100644
--- a/gcalc/gcalc-group.vala
+++ b/gcalc/gcalc-group.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathGroup}
+ */
 public class GCalc.Group : Expression, MathGroup {
   internal MathGroup.Level level { get; set; }
   internal bool closed { get; set; }
diff --git a/gcalc/gcalc-minus.vala b/gcalc/gcalc-minus.vala
index bdf5ac87..990d2c5d 100644
--- a/gcalc/gcalc-minus.vala
+++ b/gcalc/gcalc-minus.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathMinus}
+ */
 public class GCalc.Minus : Expression, MathOperator, MathBinaryOperator, MathMinus {
   internal override string to_string () {
     return "-";
diff --git a/gcalc/gcalc-multiply.vala b/gcalc/gcalc-multiply.vala
index fdbe039f..f616d380 100644
--- a/gcalc/gcalc-multiply.vala
+++ b/gcalc/gcalc-multiply.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathMultiply}
+ */
 public class GCalc.Multiply : Expression, MathOperator, MathBinaryOperator, MathMultiply {
   internal override string to_string () {
     return "*";
diff --git a/gcalc/gcalc-parameter.vala b/gcalc/gcalc-parameter.vala
index 0a562576..ee7fe57e 100644
--- a/gcalc/gcalc-parameter.vala
+++ b/gcalc/gcalc-parameter.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathParameter}
+ */
 public class GCalc.Parameter : GCalc.Variable, MathParameter {
 
   public Parameter (string name) {
diff --git a/gcalc/gcalc-plus.vala b/gcalc/gcalc-plus.vala
index 2d2e36be..d23acadc 100644
--- a/gcalc/gcalc-plus.vala
+++ b/gcalc/gcalc-plus.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathPlus}
+ */
 public class GCalc.Plus : Expression, MathOperator, MathBinaryOperator, MathPlus {
   internal override string to_string () {
     return "+";
diff --git a/gcalc/gcalc-polynomial.vala b/gcalc/gcalc-polynomial.vala
index e616ddcb..5a290d51 100644
--- a/gcalc/gcalc-polynomial.vala
+++ b/gcalc/gcalc-polynomial.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathPolynomial}
+ */
 public class GCalc.Polynomial : Expression, MathPolynomial {
   internal override MathResult solve () {
     MathResult res = null;
diff --git a/gcalc/gcalc-pow.vala b/gcalc/gcalc-pow.vala
index 0fa02078..ae2ca04d 100644
--- a/gcalc/gcalc-pow.vala
+++ b/gcalc/gcalc-pow.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathPow}
+ */
 public class GCalc.Pow : Expression, MathOperator, MathPow {
   internal override string to_string () {
     return "^";
diff --git a/gcalc/gcalc-result.vala b/gcalc/gcalc-result.vala
index b1983bb0..14015034 100644
--- a/gcalc/gcalc-result.vala
+++ b/gcalc/gcalc-result.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathResult}
+ */
 public class GCalc.Result : Object, MathResult {
   private MathExpression _expression;
   public Result (MathExpression exp) {
diff --git a/gcalc/gcalc-term.vala b/gcalc/gcalc-term.vala
index aba74eda..410a3898 100644
--- a/gcalc/gcalc-term.vala
+++ b/gcalc/gcalc-term.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathTerm}
+ */
 public class GCalc.Term : Expression, MathTerm {
   internal override MathResult solve () {
     MathResult res = null;
diff --git a/gcalc/gcalc-variable.vala b/gcalc/gcalc-variable.vala
index f4ab289b..f40d72fe 100644
--- a/gcalc/gcalc-variable.vala
+++ b/gcalc/gcalc-variable.vala
@@ -18,6 +18,9 @@
  * Authors:
  *      Daniel Espinosa <esodan gmail com>
  */
+/**
+ * An implementation of {@link MathVariable}
+ */
 public class GCalc.Variable : Expression, MathVariable, Hashable {
 
   public string name { get; construct set; }
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]