Package org.djutils.buildtools

Class ParamComments

java.lang.Object

org.djutils.buildtools.ParamComments

public class ParamComments
extends Object

Utility to add or update the type foe each parameter in the javadoc of all java files in /src/main/java in all or in selected projects in the workspace. Run this utility only from Eclipse!

Copyright (c) 2018-2022 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl. The source code and binary code of this software is proprietary information of Delft University of Technology.

Author:

Alexander Verbraeck

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ParamComments.CodeVisitor	Simple visitor implementation for visiting MethodDeclaration and ConstructorDeclaration nodes.

Constructor Summary

Constructors

Constructor	Description
ParamComments()

Method Summary

Modifier and Type	Method	Description
List<String>	getLines()
boolean	isChanged()
static void	main(String[] args)
void	setChanged(boolean changed)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamComments

public ParamComments()
              throws IOException,
                     URISyntaxException

Throws:

IOException - on I/O error

URISyntaxException - on I/O error

Method Detail

main

public static void main(String[] args)
                 throws IOException,
                        URISyntaxException

Parameters:

args - String[]; none

Throws:

IOException - on I/O error

URISyntaxException - on I/O error

isChanged

public final boolean isChanged()

Returns:

changed

setChanged

public final void setChanged(boolean changed)

Parameters:

changed - boolean; set changed

getLines

public final List<String> getLines()

Returns:

lines