Package cruise.umple.docs
Class Documenter
java.lang.Object
cruise.umple.docs.Documenter
public class Documenter
extends java.lang.Object
The tool to create the html text of the Umple user manual
-
Constructor Summary
Constructors Constructor Description Documenter(java.lang.String aInputPath, java.lang.String aOutputPath)
-
Method Summary
Modifier and Type Method Description boolean
addMessage(java.lang.String aMessage)
void
delete()
boolean
generate()
java.lang.String
genPrevNext(java.lang.String direction, Content theContent)
java.lang.String
getInputPath()
java.lang.String
getMessage(int index)
java.lang.String[]
getMessages()
java.lang.String
getOutputPath()
ContentParser
getParser()
boolean
getSeriousProblem()
boolean
hasMessages()
boolean
hasParser()
int
indexOfMessage(java.lang.String aMessage)
boolean
isSeriousProblem()
int
numberOfMessages()
boolean
publish(java.lang.String path)
boolean
removeMessage(java.lang.String aMessage)
boolean
setInputPath(java.lang.String aInputPath)
boolean
setOutputPath(java.lang.String aOutputPath)
boolean
setParser(ContentParser aNewParser)
boolean
setSeriousProblem(boolean aSeriousProblem)
java.lang.String
toHtml(java.lang.String title)
java.lang.String
toString()
-
Constructor Details
-
Documenter
public Documenter(java.lang.String aInputPath, java.lang.String aOutputPath)
-
-
Method Details
-
setInputPath
public boolean setInputPath(java.lang.String aInputPath) -
setOutputPath
public boolean setOutputPath(java.lang.String aOutputPath) -
addMessage
public boolean addMessage(java.lang.String aMessage) -
removeMessage
public boolean removeMessage(java.lang.String aMessage) -
setSeriousProblem
public boolean setSeriousProblem(boolean aSeriousProblem) -
getInputPath
public java.lang.String getInputPath() -
getOutputPath
public java.lang.String getOutputPath() -
getMessage
public java.lang.String getMessage(int index) -
getMessages
public java.lang.String[] getMessages() -
numberOfMessages
public int numberOfMessages() -
hasMessages
public boolean hasMessages() -
indexOfMessage
public int indexOfMessage(java.lang.String aMessage) -
getSeriousProblem
public boolean getSeriousProblem() -
isSeriousProblem
public boolean isSeriousProblem() -
getParser
-
hasParser
public boolean hasParser() -
setParser
-
delete
public void delete() -
generate
public boolean generate() -
publish
public boolean publish(java.lang.String path) -
genPrevNext
-
toHtml
public java.lang.String toHtml(java.lang.String title) -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-