Package net.sourceforge.jarduino.message

Class ArduinoComments

java.lang.Object

net.sourceforge.jarduino.message.ArduinoComments

public class ArduinoComments
extends Object

Comments.

Method Summary

Modifier and Type	Method	Description
String	getCommentForObject(ArduinoNamedObject pObject)	Obtain the comment for an object (if any).
static void	parseComment(ArduinoSystem pSystem, String pCommentDef)	parse the comment definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getCommentForObject

public String getCommentForObject(ArduinoNamedObject pObject)

Obtain the comment for an object (if any).

Parameters:

pObject - the object

Returns:

the comment (or null)

parseComment

public static void parseComment(ArduinoSystem pSystem,
String pCommentDef)
                         throws ArduinoException

parse the comment definition.

Parameters:

pSystem - the system

pCommentDef - the comment definition

Throws:

ArduinoException - on error