From aef4e8398f2b1848b0e4cdd9580dbbe93e4006f9 Mon Sep 17 00:00:00 2001
From: Jorawar Singh
Date: Fri, 30 Jun 2017 11:28:58 +0530
Subject: Help files, modified Raspberry Pi code conversion

---
 macros/Hardware/AVR/AVRPWM1Setup.sci | 54 ++++++++++++++++++------------------
 1 file changed, 27 insertions(+), 27 deletions(-)

(limited to 'macros/Hardware/AVR/AVRPWM1Setup.sci')

diff --git a/macros/Hardware/AVR/AVRPWM1Setup.sci b/macros/Hardware/AVR/AVRPWM1Setup.sci
index 51aa25b..fbd96ce 100644
--- a/macros/Hardware/AVR/AVRPWM1Setup.sci
+++ b/macros/Hardware/AVR/AVRPWM1Setup.sci
@@ -10,38 +10,40 @@
 
 function AVRPWM1Setup(waveform_mode,output_mode,output_pin)
 //Function to Setup OC1A or OC1B pin for required PWM mode
+//
+//Parameters
+//	waveform_mode: integer, from 0 to 2
+//      output_mode: integer, from 0 to 1 (or 2) depending on the waveform_mode
+//      output_pin: 0 (for OC1A) or 1 for (OC1B)
+//
 //Description
 //	Every Micro controller has PWM pins which can generate varying voltages
 //	from 0V-5V.This function helps to use OC1A or OC1B pin to produces required 
 //	output waveform by setting the waveform mode and otput mode.
 //
-//Parameters
-//	waveform_mode:
-//                   0 for Phase correct PWM Mode
-//                   1 for Fast PWM Mode 
-//                   2 for CTC Mode
+//	waveform_mode can take values-
+//	<itemizedlist>
+//      <listitem><para>0   -> for Phase correct PWM Mode</para></listitem>
+//      <listitem><para>1   -> for Fast PWM Mode</para></listitem>
+//      <listitem><para>2   -> for CTC Mode</para></listitem>
+//      </itemizedlist>
 //
-//	output_mode:
-//            For Phase Correct PWM Mode:
-//                   0 for Clear OC1A or OC1B on compare match when up-counting. Set OC1A or OC1B
-//                   on compare match when down-counting.                   
-//                   1 for Set OC1A or OC1B on compare match when up-counting. Clear OC1A or OC1B 
-//                   on compare match when down-counting.                   
-// 
-//            For Fast PWM Mode:
-//                   0 for non-inverted output i.e Clear OC1A or OC1B on compare match, set  OC1A
-//                   OC1B at BOTTOM.    
-//                   1 for inverted output i.e Set OC1A or OC1B on compare match, clear OC1A or OC1B
-//                   at BOTTOM. 
-//        
-//            For CTC Mode:
-//                   0 to Clear OC1A or OC1B on compare match
-//                   1 to Set OC1A or OC1B on compare match
-//                   2 to toggle OC1A or OC1B on compare match
+//	output_mode can take values-
+//      <itemizedlist>
+//      For Phase correct PWM Mode:
+//	<listitem><para>0 for Clear OC1A or OC1B on compare match when up-counting. Set OC1A or OC1B on compare match when down-counting.</para></listitem>
+//	<listitem><para>1 for Set OC1A or OC1B on compare match when up-counting. Clear OC1A or OC1B on compare match when down-counting.</para></listitem>
+//      For Fast PWM Mode:
+//	<listitem><para>0 for non-inverted output i.e Clear OC1A or OC1B on compare match, set OC1A or OC1B at BOTTOM.</para></listitem>
+//	<listitem><para>1 for inverted output i.e Set OC1A or OC1B on compare match, clear OC1A or OC1B at BOTTOM.</para></listitem>
+//      For CTC Mode:
+//	<listitem><para>0 to Clear OC1A or OC1B on compare match</para></listitem>
+//	<listitem><para>1 to Set OC1A or OC1B on compare match</para></listitem>
+//	<listitem><para>2 to toggle OC1A or OC1B on compare match</para></listitem>
+//      </itemizedlist>
 //
-//      output_pin: 
-//                   0 for selecting OC1A as output pin 
-//                   1 for selecting OC1B as output pin
+// This is curretly dummy function. It provides no functionality but is required 
+// for providing support for generating C code for AVR.
 //
 //Example
 //    AVRPWM1Setup(2,0,0);  //This function will select CTC mode and will clear OC1A or OC1B 
@@ -53,8 +55,6 @@ function AVRPWM1Setup(waveform_mode,output_mode,output_pin)
 //Authors
 //     Ashish Kamble
 //
-// This is curretly dummy function. It provides no functionality but is required 
-// for providing support for generating C code for AVR.
 
 if(waveform_mode>=3) then 
 disp("Error : Invalid input argument ''waveform_mode'' in AVRPWM1Setup function.");
-- 
cgit