add comments to all public interfaces

lab1/zad1/include/mod.h

@@ -3,15 +3,30 @@
 
 #include <stdint.h>
 
+/*
+ * computes the factorial of n
+ * only works on natural numbers
+ */
 uint64_t factorial(uint64_t n);
 
+/*
+ * computes the gcd of a and b
+ * only works on natural numbers
+ */
 uint64_t gcd(uint64_t a, uint64_t b);
 
+/*
+ * the solution of a linear diophantine equation 
+ */
 typedef struct {
     int64_t n;
     int64_t m;
 } Result;
 
+/*
+ * computes the solution of a linear diophantine equation ax + by = c
+ * or returns NULL if it doesn't exist
+ */
 Result *diophantine(int64_t a, int64_t b, int64_t c);
 
 #endif // _JPP_L1_Z1_MOD_H

lab1/zad2/src/module.ads

@@ -3,16 +3,23 @@ with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
 
 package Module is
 
+    -- computes the factorial of n
+    -- only works on natural numbers
     function gcd(a : Natural; b : Natural) return Natural;
 
+    -- computes the gcd of a and b
+    -- only works on natural numbers
     function factorial(n : Natural) return Natural;
 
+    -- the solution of a linear diophantine equation 
     type Result is record
         resultExists : Boolean;
         n : Integer;
         m : Integer;
     end record;
 
+    -- computes the solution of a linear diophantine equation ax + by = c
+    -- if the solution doesn't exist Result::resultExists == false
     function diophantine(a : Integer; b : Integer; c : Integer) return Result;
 
 end Module;

lab1/zad3/src/module.rs

@@ -1,8 +1,14 @@
 pub trait Module {
+    /// computes the factorial of n
+    /// only works on natural numbers
     fn factorial(&self, n: u64) -> u64;
 
+    /// computes the gcd of a and b
+    /// only works on natural numbers
     fn gcd(&self, a: u64, b: u64) -> u64;
 
+    /// computes the solution of a linear diophantine equation ax + by = c
+    /// or returns None if it doesn't exist
     fn diophantine(&self, a: i64, b: i64, c: i64) -> Option<(i64, i64)>;
 }
 

lab1/zad4/include/wrapper.h

@@ -3,16 +3,31 @@
 
 #include <stdbool.h>
 
+/*
+ * computes the gcd of a and b
+ * only works on natural numbers
+ */
 extern unsigned int gcd(unsigned int a, unsigned int b);
 
+/*
+ * computes the factorial of n
+ * only works on natural numbers
+ */
 extern unsigned int factorial(unsigned int n);
 
+/*
+ * the solution of a linear diophantine equation 
+ */
 typedef struct {
     bool resultExists;
     int n;
     int m;
 } Result;
 
+/*
+ * computes the solution of a linear diophantine equation ax + by = c
+ * if the solution doesn't exist Result::resultExists == false
+ */
 extern Result diophantine(int a, int b, int c);
 
 #endif // _JPP_L1_Z4_WRAPPER_H

lab1/zad5/include/mod.h

@@ -4,16 +4,31 @@
 #include <stdbool.h>
 #include <stdint.h>
 
+/*
+ * computes the factorial of n
+ * only works on natural numbers
+ */
 unsigned int factorial(unsigned int n);
 
+/*
+ * computes the gcd of a and b
+ * only works on natural numbers
+ */
 unsigned int gcd(unsigned int a, unsigned int b);
 
+/*
+ * the solution of a linear diophantine equation 
+ */
 typedef struct {
     bool resultExists;
     int n;
     int m;
 } Result;
 
+/*
+ * computes the solution of a linear diophantine equation ax + by = c
+ * if the solution doesn't exist Result::resultExists == false
+ */
 Result diophantine(int a, int b, int c);
 
 #endif // _JPP_L1_Z5_MOD_H

lab1/zad6/src/main.rs

@@ -1,5 +1,6 @@
 use std::{env, process::exit};
 
+/// the solution of a linear diophantine equation 
 #[repr(C)]
 pub struct Result {
   pub resultExists: libc::c_int,
@@ -8,10 +9,16 @@ pub struct Result {
 }
 
 extern "C" {
+    /// computes the gcd of a and b
+    /// only works on natural numbers
     pub fn gcd(a: libc::c_uint, b: libc::c_uint) -> libc::c_uint;
 
+    /// computes the factorial of n
+    /// only works on natural numbers
     pub fn factorial(n: libc::c_uint) -> libc::c_uint;
 
+    /// computes the solution of a linear diophantine equation ax + by = c
+    /// if the solution doesn't exist Result::resultExists == false
     pub fn diophantine(a: libc::c_int, b: libc::c_int, c: libc::c_int) -> Result;
 }
 

lab1/zad7/c/wrapper.h

@@ -3,16 +3,31 @@
 
 #include <stdbool.h>
 
+/*
+ * computes the gcd of a and b
+ * only works on natural numbers
+ */
 extern unsigned int gcd(unsigned int a, unsigned int b);
 
+/*
+ * computes the factorial of n
+ * only works on natural numbers
+ */
 extern unsigned int factorial(unsigned int n);
 
+/*
+ * the solution of a linear diophantine equation 
+ */
 typedef struct {
     bool resultExists;
     int n;
     int m;
 } Result;
 
+/*
+ * computes the solution of a linear diophantine equation ax + by = c
+ * if the solution doesn't exist Result::resultExists == false
+ */
 extern Result diophantine(int a, int b, int c);
 
 #endif // _JPP_L1_Z7_WRAPPER_H