Package org.opentrafficsim

Class ParamComments

  • public class ParamComments
extends java.lang.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) 2003-2020 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getLines()  
      boolean isChanged()  
      static void main​(java.lang.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 java.io.IOException,
                     java.net.URISyntaxException
        Throws:
        java.io.IOException - on I/O error
        java.net.URISyntaxException - on I/O error

    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                 throws java.io.IOException,
                        java.net.URISyntaxException
        Parameters:
        args - String[]; none
        Throws:
        java.io.IOException - on I/O error
        java.net.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 java.util.List<java.lang.String> getLines()
        Returns:
        lines