rschaten/Binary_DCF77_Clock
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improved comments

Browse Source
This commit is contained in:
Ronald Schaten
2007-01-03 12:38:55 +00:00
parent 8c0e19cf1c
commit 1f77141a10
5 changed files with 69 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
firmware/dcftime.c
View File

@@ -2,7 +2,7 @@
* \file dcftime.c
* \brief Decoder for DCF-77 time signals
* \author Ronald Schaten & Thomas Stegemann
* \version $Id: dcftime.c,v 1.1 2007/01/02 21:30:40 rschaten Exp $
* \version $Id: dcftime.c,v 1.2 2007/01/03 12:38:55 rschaten Exp $
*
* License: See documentation.
*/
@@ -78,7 +78,7 @@ static struct dcf_data_struct dcf_data; /**< full set of received dcf data */
/**
* Initialize a dcf_time value.
* \param pTime: pointer to a dcf_time variable
* \param pTime pointer to a dcf_time variable
*/
static void dcf_time_init(dcf_time * pTime) {
pTime->second = 0;
@@ -89,7 +89,7 @@ static void dcf_time_init(dcf_time * pTime) {
/**
* Increment a time-value by one second.
* \param pTime: pointer to a dcf_time variable
* \param pTime pointer to a dcf_time variable
* \return True if the date has to be incremented, too. Otherwise False.
*/
static boolean dcf_time_inc(dcf_time * pTime) {
@@ -111,7 +111,7 @@ static boolean dcf_time_inc(dcf_time * pTime) {
/**
* Check if a time-value makes sense.
* \param pTime: pointer to a dcf_time variable
* \param pTime pointer to a dcf_time variable
* \return True if the time is logically correct. Otherwise False.
*/
static boolean dcf_time_is_valid(dcf_time * pTime) {
@@ -126,7 +126,7 @@ static boolean dcf_time_is_valid(dcf_time * pTime) {
/**
* Initialize a dcf_date value.
* \param pDate: pointer to a dcf_date variable
* \param pDate pointer to a dcf_date variable
*/
static void dcf_date_init(dcf_date * pDate) {
pDate->dayofweek = dcf_sunday;
@@ -137,7 +137,7 @@ static void dcf_date_init(dcf_date * pDate) {
/**
* Calculate the number of days in a month.
* \param pDate: pointer to a dcf_time variable
* \param pDate pointer to a dcf_time variable
* \return The number of days in the given month.
*/
static dcf_sizetype dcf_date_days_in_month(dcf_date * pDate) {
@@ -173,7 +173,7 @@ static dcf_sizetype dcf_date_days_in_month(dcf_date * pDate) {
/**
* Increment a date-value by one day.
* \param pDate: pointer to a dcf_date variable
* \param pDate pointer to a dcf_date variable
*/
static void dcf_date_inc(dcf_date * pDate) {
++(pDate->dayofweek);
@@ -197,7 +197,7 @@ static void dcf_date_inc(dcf_date * pDate) {
/**
* Check if a date-value makes sense.
* \param pDate: pointer to a dcf_date variable
* \param pDate pointer to a dcf_date variable
* \return True if the date is logically correct. Otherwise False.
*/
static boolean dcf_date_is_valid(dcf_date * pDate) {
@@ -215,7 +215,7 @@ static boolean dcf_date_is_valid(dcf_date * pDate) {
*/
/**
* Initialize a dcf_datetime value.
* \param pDatetime: pointer to a dcf_datetime variable
* \param pDatetime pointer to a dcf_datetime variable
*/
static void dcf_datetime_init(dcf_datetime * pDatetime) {
pDatetime->is_valid = False;
@@ -226,7 +226,7 @@ static void dcf_datetime_init(dcf_datetime * pDatetime) {
/**
* Increment a datetime-value by one second.
* \param pDatetime: pointer to a dcf_datetime variable
* \param pDatetime pointer to a dcf_datetime variable
*/
static void dcf_datetime_inc(dcf_datetime * pDatetime) {
if (dcf_time_inc(&(pDatetime->time))) {
@@ -240,7 +240,7 @@ static void dcf_datetime_inc(dcf_datetime * pDatetime) {
/**
* Initialize a dcf_receiving_data value.
* \param pReceive: pointer to a dcf_receiving_data variable
* \param pReceive pointer to a dcf_receiving_data variable
*/
static void dcf_receiving_data_init(dcf_receiving_data * pReceive) {
pReceive->current_signal = dcf_signal_no;
@@ -254,7 +254,7 @@ static void dcf_receiving_data_init(dcf_receiving_data * pReceive) {
/**
* Calculate the time and date while the bits are received.
* \param signal: True if the received bit is 200ms, False if the bit is 100ms.
* \param signal True if the received bit is 200ms, False if the bit is 100ms.
*/
static void dcf_logic(boolean signal) {
dcf_data.receiving_data.parity ^= signal;