def setUp(self):
self.tok = lexer.Token('COMMAND_RETURN', '@return', 0, 0, 0)
self.tok_name = lexer.Token('WORD', 'name', 0, 0, 0)
self.tok_text = lexer.Token('WORD', 'text', 0, 0, 0)
self.txt_name = raw_doc.RawText([self.tok_name])
self.txt_text = raw_doc.RawText([self.tok_text])
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.tok = lexer.Token('COMMAND_TPARAM', '@tparam', 0, 0, 0)
self.tok_name = lexer.Token('WORD', 'name', 0, 0, 0)
self.tok_text = lexer.Token('WORD', 'text', 0, 0, 0)
self.txt_name = raw_doc.RawText([self.tok_name])
self.txt_text = raw_doc.RawText([self.tok_text])
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.tok = lexer.Token('COMMAND_THROW', '@throw', 0, 0, 0)
self.tok_type = lexer.Token('WORD', 'type', 0, 0, 0)
self.tok_text = lexer.Token('WORD', 'text', 0, 0, 0)
self.txt_type = raw_doc.RawText([self.tok_type])
self.txt_text = raw_doc.RawText([self.tok_text])
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.tok = lexer.Token('COMMAND_PARAM', '@param', 0, 0, 0)
self.tok_name = lexer.Token('WORD', 'name', 0, 0, 0)
self.tok_text = lexer.Token('WORD', 'text', 0, 0, 0)
self.tok_inout = lexer.Token('PARAM_IN_OUT', '[in,out]', 0, 0, 0)
self.txt_name = raw_doc.RawText([self.tok_name])
self.txt_text = raw_doc.RawText([self.tok_text])
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.path_t = lexer.Token('WORD', 'apath', 0, 0, 0)
self.path = raw_doc.RawText([self.path_t])
self.snippet_t0 = lexer.Token('WORD', 'The', 0, 0, 0)
self.snippet_t1 = lexer.Token('SPACE', ' ', 0, 0, 0)
self.snippet_t2 = lexer.Token('WORD', 'snippet', 0, 0, 0)
self.snippet = raw_doc.RawText(
[self.snippet_t0, self.snippet_t1, self.snippet_t2])
self.formatter = raw_doc.DoxFormatter()
def testGetFormatted(self):
b = raw_doc.RawBrief(self.brief_tok, raw_doc.RawText([self.brief_tok]))
entry = raw_doc.RawEntry(self.brief_tok, [b])
entry.name = raw_doc.RawText([self.name_tok])
entry.title = raw_doc.RawText([self.title_tok])
entry.sees = [
raw_doc.RawSee(self.tok_see, raw_doc.RawText([self.tok_see]))
]
formatter = raw_doc.DoxFormatter()
msg = ('@<entry> Concept Concept Title\n\n'
'@brief This is brief.\n\n'
'@see See\n\n')
self.assertMultiLineEqual(entry.getFormatted(formatter), msg)
def testGetFormatted(self):
b = raw_doc.RawBrief(self.brief_tok, raw_doc.RawText([self.brief_tok]))
code_entry = raw_doc.RawVariable(self.brief_tok, [b])
code_entry.name = raw_doc.RawText([self.name_tok])
code_entry.type = raw_doc.RawText([self.type_tok])
code_entry.sees = [
raw_doc.RawSee(self.tok_see, raw_doc.RawText([self.tok_see]))
]
s = raw_doc.RawSignature(self.tok_sig, raw_doc.RawText([self.tok_sig]))
code_entry.addSignature(s)
txt = ('@var int var;\n\n'
'@brief This is brief.\n\n'
'@signature payload\n\n'
'@see See\n\n')
self.assertMultiLineEqual(code_entry.getFormatted(self.formatter), txt)
def testAddSee(self):
entry = raw_doc.RawEntry(self.tok_see)
self.assertEqual(entry.sees, [])
s = raw_doc.RawSee(self.tok_see, raw_doc.RawText())
entry.addSee(s)
self.assertEqual(len(entry.sees), 1)
self.assertEqual(entry.sees, [s])
def testInitialization(self):
entry = raw_doc.RawEntry(self.tok)
self.assertEqual(entry.name.text, raw_doc.RawText().text)
self.assertEqual(len(entry.briefs), 0)
self.assertEqual(entry.body, raw_doc.RawBody())
self.assertEqual(entry.sees, [])
self.assertEqual(entry.command, '<entry>')
def testAddBrief(self):
entry = raw_doc.RawEntry(self.tok)
self.assertEqual(entry.briefs, [])
b = raw_doc.RawBrief(self.brief_tok, raw_doc.RawText())
entry.addBrief(b)
self.assertEqual(len(entry.briefs), 1)
self.assertEqual(entry.briefs, [b])
def testGetFormatted(self):
code_entry = raw_doc.RawCodeEntry(self.code_tok)
b = raw_doc.RawBrief(self.brief_tok, raw_doc.RawText([self.brief_tok]))
code_entry = raw_doc.RawCodeEntry(self.code_tok, [b])
code_entry.name = raw_doc.RawText([self.name_tok])
code_entry.title = raw_doc.RawText([self.title_tok])
code_entry.sees = [
raw_doc.RawSee(self.tok_see, raw_doc.RawText([self.tok_see]))
]
s = raw_doc.RawSignature(self.tok_sig, raw_doc.RawText([self.tok_sig]))
code_entry.addSignature(s)
formatter = raw_doc.DoxFormatter()
txt = ('@<code entry> Concept Concept Title\n\n'
'@brief This is brief.\n\n'
'@signature payload\n\n'
'@see See\n\n')
self.assertMultiLineEqual(code_entry.getFormatted(formatter), txt)
def testConstructionWithTokens(self):
tokens = [
lexer.Token('WORD', 'test', 0, 0, 0),
lexer.Token('SPACE', ' ', 0, 0, 0),
lexer.Token('WORD', 'foo', 0, 0, 0)
]
text = raw_doc.RawText(tokens)
self.assertEqual(text.tokens, tokens)
self.failIf(text.empty)
def testAddSignature(self):
code_entry = raw_doc.RawCodeEntry(self.code_tok)
s = raw_doc.RawSignature(
self.sig_tok,
raw_doc.RawText([lexer.Token('WORD', 'payload', 0, 0, 0)]))
code_entry.addSignature(s)
def setUp(self):
self.tok = lexer.Token('COMMAND_DATARACE', '@datarace', 0, 0, 0)
self.tok_text = lexer.Token('WORD', 'text', 0, 0, 0)
self.txt_text = raw_doc.RawText([self.tok_text])
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.tok = lexer.Token('COMMAND_SIGNATURE', '@signature', 0, 0, 0)
self.tok_text = lexer.Token('WORD', 'text', 0, 0, 0)
self.txt_text = raw_doc.RawText([self.tok_text])
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.t = lexer.Token('WORD', 'aword', 0, 0, 0)
self.p = raw_doc.RawParagraph(self.t, raw_doc.RawText([self.t]))
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.path_t = lexer.Token('WORD', 'apath', 0, 0, 0)
self.path = raw_doc.RawText([self.path_t])
self.formatter = raw_doc.DoxFormatter()
def setUp(self):
self.t = lexer.Token('WORD', 'aword', 0, 0, 0)
self.txt = raw_doc.RawText([self.t])
self.formatter = raw_doc.DoxFormatter()
def testConstructionWithoutTokens(self):
text = raw_doc.RawText()
self.assertEqual(text.tokens, [])
self.assert_(text.empty)
