Package ch.sahits.game.openpatrician.app.display

Class TodoLister

java.lang.Object

ch.sahits.game.openpatrician.app.display.DocumentationUtility

ch.sahits.game.openpatrician.app.display.TodoLister

public class TodoLister
extends DocumentationUtility

Utility class to list all FIXMEs and TODOs in the code and format it for direct use in the wiki.

Author:

Andi Hotz, (c) Sahits GmbH, 2014 Created on Nov 18, 2014

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	fixmes
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	todos

Fields inherited from class ch.sahits.game.openpatrician.app.display.DocumentationUtility

JAVA_SOURCE, rootDirectory

Constructor Summary

Constructors

Constructor	Description
TodoLister()

Method Summary

Modifier and Type	Method	Description
private void	addTabel(java.lang.StringBuffer sb, java.util.Map<java.lang.String,java.util.List<java.lang.String>> todos)
protected java.lang.String	createOutput()
private java.util.List<java.lang.String>	findComments(java.io.File file, java.lang.String marker)	Find all annotations in a file.
static void	main(java.lang.String[] args)

Methods inherited from class ch.sahits.game.openpatrician.app.display.DocumentationUtility

findJavaFilesIn, getModuleNames, getTypeFromFilePath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fixmes

private java.util.Map<java.lang.String,java.util.List<java.lang.String>> fixmes

todos

private java.util.Map<java.lang.String,java.util.List<java.lang.String>> todos

Constructor Detail

TodoLister

public TodoLister()

Method Detail

main

public static void main(java.lang.String[] args)

createOutput

protected java.lang.String createOutput()

Specified by:

createOutput in class DocumentationUtility

addTabel

private void addTabel(java.lang.StringBuffer sb,
                      java.util.Map<java.lang.String,java.util.List<java.lang.String>> todos)

findComments

private java.util.List<java.lang.String> findComments(java.io.File file,
                                                      java.lang.String marker)
                                               throws java.io.IOException

Find all annotations in a file.

Parameters:

file - to check for comments

marker - template to seach for

Returns:

List of matching comments

Throws:

java.io.IOException - if file could not be read.