Enhanced C#
Loyc library documentation
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Properties | Public Member Functions | List of all members
LeMP.LexicalMacroAttribute Class Reference

Marks a method as a LeMP lexical macro. More...


Source file:
Inheritance diagram for LeMP.LexicalMacroAttribute:
LeMP.MacroInfo

Remarks

Marks a method as a LeMP lexical macro.

To be recognized as a macro, the method must be public and static and its signature must be LexicalMacro. A class will not be automatically searched for macros unless the class is marked with ContainsMacrosAttribute.

Properties

string Syntax [get, set]
 
string Description [get, set]
 
string[] Names [get, set]
 
MacroMode Mode [get, set]
 
MacroMode Priority [get]
 
string[] DeprecatedNames [get, set]
 A list of names of the macro that have been deprecated. If a name is included in this list, it is not necessary to also include it in the list of Names, but doing so is allowed and won't make a difference. More...
 
string DeprecationMessage [get, set]
 A message to show when the deprecated macro is used. It is not necessary to set this property if the macro was simply renamed, as LeMP can automatically tell the user about the new name if both versions use the same method. More...
 

Public Member Functions

 LexicalMacroAttribute (string syntax, string description, params string[] names)
 LexicalMacroAttribute constuctor. More...
 

Constructor & Destructor Documentation

LeMP.LexicalMacroAttribute.LexicalMacroAttribute ( string  syntax,
string  description,
params string[]  names 
)
inline

LexicalMacroAttribute constuctor.

Parameters
syntaxA string that shows the expected syntax used to call the node.
description
names

Property Documentation

string [] LeMP.LexicalMacroAttribute.DeprecatedNames
getset

A list of names of the macro that have been deprecated. If a name is included in this list, it is not necessary to also include it in the list of Names, but doing so is allowed and won't make a difference.

string LeMP.LexicalMacroAttribute.DeprecationMessage
getset

A message to show when the deprecated macro is used. It is not necessary to set this property if the macro was simply renamed, as LeMP can automatically tell the user about the new name if both versions use the same method.