Doc.java

/*  MonkeyTalk - a cross-platform functional testing tool
    Copyright (C) 2012 Gorilla Logic, Inc.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
package com.gorillalogic.monkeytalk.api;

/**
 * Document the script and its named variables.
 * 
 * @ignoreJS
 */
public interface Doc extends MTObject {

	/**
	 * Document the named variables used in the script.
	 * 
	 * @param args
	 *            the named variables and their doc, in the form of: var="some doc" var2="other doc"
	 */
	public void vars(String... args);

	/**
	 * Document the script itself.
	 * 
	 * @param doc
	 *            the doc
	 */
	public void script(String doc);
}