From 003b94dcdbd65ed6aa279a87d06fd1af8676ec22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20A=2E=20Ortega?= Date: Wed, 14 Dec 2016 16:14:58 +0100 Subject: [PATCH] Added some more useful docs and stuff. --- src/list.h | 10 ++++++++-- src/main.c | 10 ++++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/src/list.h b/src/list.h index 272a4ea..77b5506 100644 --- a/src/list.h +++ b/src/list.h @@ -1,3 +1,10 @@ +/** + * @file list.h + * @author Deathsbreed + * @brief Code responsible for List management. + * @details Code responsible for the definition and management of the + * List object. + */ #pragma once #include #include @@ -14,8 +21,7 @@ typedef struct { /** * @brief Initialize a List. * @details Initialize the list and its variables, allocating memory - * to the pointer array inside. Returns true on success and false on - * failure. + * to the pointer array inside. * @param[in] l A pointer to a List type to be initialized. */ void initList(List *restrict l); diff --git a/src/main.c b/src/main.c index 4dbf6fc..8affedb 100644 --- a/src/main.c +++ b/src/main.c @@ -7,6 +7,7 @@ #include "list.h" static bool run; + void leave(); int main(void) { @@ -41,7 +42,10 @@ int main(void) { do { // Calculate half of `num' mpz_fdiv_q_ui(halfNum, num, 2); - // Loop through found primes + /** + * Loop through primes we've found until we get to half of the number + * we're analyzing + */ for(size_t i = 0; mpz_cmp(primes.list[i], halfNum) < 0; ++i) { // If `num' is divisible by a prime then go to the next number if(mpz_divisible_p(num, primes.list[i]) != 0) @@ -73,6 +77,4 @@ nextPrime: return 0; } -void leave() { - run = false; -} +void leave() { run = false; }