Changes between Version 3 and Version 4 of CompilerDirectives

Timestamp:

10/14/12 22:24:17 (12 years ago)

Author:

hopscc

Comment:

--

CompilerDirectives

@@ -1 @@
-Compiler directives are options, instructions, hints provided to compiler[[BR]]
-from with in code files. especially in cobra they are much more than[[BR]]
-#define,#if of c,c++,c#. In cobra one can pass arguments to compiler[[BR]]
-from within code file. which otherwise needs to be passed from commandline.[[BR]]
+= Cobra Compiler Directives =
+
+Compiler directives are options, instructions or hints provided to compiler[[BR]]
+from within code files. These may be items also provided as commandline args.
 
 
-various cobra Compiler directives are[[BR]]
+The various cobra Compiler directives are[[BR]]
 
  @args[[BR]]
- @number[[BR]]
  @ref[[BR]]
  @help[[BR]]
- @throw       <---for internal use by cobra..[[BR]]
+ @number[[BR]]
+ @platform[[BR]]
  @error[[BR]]
  @warning[[BR]]
-[[BR]]
-[[BR]]
-[[BR]]
+ @throw       <---for internal use by cobra..[[BR]]
+
+
 
 
  '''@args'''[[BR]]
- 1) @args -t:winexe [[BR]]
-     is a example of specifing that current assembly shouldbe compiled as[[BR]]
+ Specifies the provision of a (cobra compiler commandline) arg.[[BR]]
+ The option follows the @args as if given on the compiler commandline.
+
+ e.g.[[BR]]
+{{{ @args -t:winexe }}}
+     specify a compiler option giving a commandline arg that indicates that the current assembly should be compiled as a
      Windows Executable[[BR]]
- 2) @args -lib:'C:\Program Files\Reference Assemblies\Microsoft\Framework\v3.0'
-     is a example of specifing search directory for assemblies by cobra compiler
-     to find the referenced assemblies.[[BR]]
-[[BR]]
-[[BR]]
-[[BR]]
+{{{@args -lib:'C:\Program Files\Reference Assemblies\Microsoft\Framework\v3.0' }}}
+     specifies a search directory for the cobra compiler to look in 
+     to find any referenced assemblies.[[BR]]
+
+
+
 
 '''@ref'''[[BR]]
- 1)@ref "PresentationFramework"[[BR]]
-         is a example of referencing  "PresentationFramework" assembly from GAC which [[BR]]
-         would otheriwse have been -ref:"PresentationFramework" on commandline[[BR]]
- 2) @ref 'c:\somedirectory\validAssembly.exe'[[BR]]
- 3) @ref 'c:\somedirectory\validAssembly.dll'[[BR]]
-         above two examples reference assemblies by giving absolute paths for both .exe and .dll[[BR]]
-[[BR]]
-[[BR]]
-[[BR]]
+ Indicates explicitly an assembly filename for the resolution of (used) references. 
+
+e.g.[[BR]]
+{{{
+@ref "PresentationFramework"
+}}}
+   specifies referencing  "PresentationFramework" assembly from GAC which
+         could otherwise have been given as -ref:"PresentationFramework" on the commandline[[BR]]
+{{{
+@ref 'c:\somedirectory\validAssembly.exe'
+@ref 'c:\somedirectory\validAssembly.dll'
+}}}
+   specifies referencing assemblies by giving absolute paths to both .exe and .dll files[[BR]]
+
+
+
 '''@help'''[[BR]]
- 1)http://cobra-language.com/forums/viewtopic.php?f=4&t=810&p=4195#p4125
-[[BR]]
-[[BR]]
-[[BR]]
-[[BR]]
+Directive to generate an HTML help file for a given expression, statement or declaration.[[BR]]
+The output file is intended to give the developer:
+ * information about the topic in general
+ * interfaces to types
+ * a link to the Cobra wiki where appropriate
+ * a link to the specific type's documentation on the web, where determinable
+ * ready-made search links
+
+ See http://cobra-language.com/forums/viewtopic.php?f=4&t=810&p=4195#p4125
+
+
+
+
+
+
 '''@number'''[[BR]]
- 1)http://cobra-language.com/trac/cobra/wiki/Troubleshooting
+ Set the actual numeric type for any uses of both the 'Number' type and the default numeric type for any fractional literals (such as '1.0').[[BR]]
+
+This usually defaults to Decimal.
+( see CommandLine option 'Number')
+
+
+ See http://cobra-language.com/trac/cobra/wiki/Troubleshooting
+
+
+
+'''@platform'''[[BR]]
+Directive to specify that this source is specifically intended (only) for a specific platform.
+Presumably the code uses libraries or API's only available on that platform. 
+If the platform directive and the compiler option backend settings are not compatible compilation will be aborted.
+
+Values may be one of :
+ * any - default - build on any platform (explicitly) 
+ * portable  - (future) build for a 'portable' platform
+ * clr - build for a CLR platform ( .Net - Windows and mono)
+ * jvm - build for a jvm platform
+ * objc - (future) build for an objective-C platform
+
+
+e.g.
+{{{
+@platform jvm
+# build only on/for jvm platform 
+
+@platform any
+# same as default
+}}}
+
+Additional (or different) platforms may be supported (or completed) in the future.