ConForM.CoopnTools.Doc
Class DocEnv
java.lang.Object
|
+--ConForM.CoopnTools.CoKer.CoopnEnv
|
+--ConForM.CoopnTools.Doc.DocEnv
- All Implemented Interfaces:
- java.lang.Cloneable
- public class DocEnv
- extends CoopnEnv
Documenter environment. Definition of environments dealing with the Documenter
tool.
Fields inherited from class ConForM.CoopnTools.CoKer.CoopnEnv |
cocoRead, cocoWrite, coopnHome, coopnLibs, debug, editor, err, in, locale, names, out, packageFile, project, queryHelp, queryVersion, queryXHelp, user, useThreads, verbose, warn |
Constructor Summary |
DocEnv(CoopnUser name)
Simple constructor. |
DocEnv(java.lang.String name)
Simple constructor. |
Method Summary |
java.lang.Object |
clone()
Returns a clone environment. |
void |
copyFrom(DocEnv env)
Copy the fields of an environment from another one. |
java.lang.String |
toString()
String converion. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
format
public int format
- Output format.
- See Also:
DocWriter
privateMode
public boolean privateMode
- Private mode. In this mode, not only public, but also private (i.e.
body) elements are documented.
DocEnv
public DocEnv(java.lang.String name)
- Simple constructor.
- Parameters:
name
- the name of the tool
DocEnv
public DocEnv(CoopnUser name)
- Simple constructor.
- Parameters:
name
- the user
toString
public java.lang.String toString()
- String converion.
- Overrides:
toString
in class CoopnEnv
copyFrom
public void copyFrom(DocEnv env)
throws CoopnEnvException
- Copy the fields of an environment from another one. The user field
is not affected.
clone
public java.lang.Object clone()
- Returns a clone environment.
- Overrides:
clone
in class CoopnEnv