ADC comments added

diff --git a/rpp/lib/cmdproc/src/commands/cmd_adc.c b/rpp/lib/cmdproc/src/commands/cmd_adc.c
index ad7fd67f484eb9f49ea9bb743377cefc1147cefe..9a366bbf8808121b0794436676dc9f0d648d13e1 100644 (file)
--- a/rpp/lib/cmdproc/src/commands/cmd_adc.c
+++ b/rpp/lib/cmdproc/src/commands/cmd_adc.c
@@ -1,10 +1,29 @@
 /*
- * cmd_adc.c
+ * Copyright (C) 2012-2013 Czech Technical University in Prague
  *
- *  Created on: 28.2.2013
- *      Author: Michal Horn
+ * Created on: 28.2.2013
+ *
+ * Authors:
+ *     - Michal Horn
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * File : cmd_adc.c
+ *
+ * Abstract:
+ *     This file contains command for reading adc port.
  *
- *  Commands for ADC1 port reading
  */
 
 #include "commands/cmd_adc.h"
@@ -12,11 +31,15 @@
 #include "rpp/rpp.h"
 
 
-/**    Reads values from ADC1 pins
+/**
+ * @brief Read ADC port
+ *
+ * Command syntax: readadc
+ *
  * @param[in]  cmd_io  Pointer to IO stack
  * @param[in]  des             Pointer to command descriptor
  * @param[in]  param   Parameters of command
- * @return     0 when OK or error code
+ * @return 0 when OK or error code lower than 0
  */
 int cmd_do_read_adc1_values(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 {
@@ -31,7 +54,7 @@ int cmd_do_read_adc1_values(cmd_io_t *cmd_io, const struct cmd_des *des, char *p
     return 0;
 }
 
-/** Descriptor of command for lin loopback test */
+/** Descriptor of command for adc port reading */
 cmd_des_t const cmd_des_read_adc1={
     0, 0,
     "readadc","Reads values from ADC1",