GenericDocTag.java

/*******************************************************************************
 * Copyright (c) 2008 Symbian Software Systems and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * Andrew Ferguson (Symbian) - Initial implementation
 *******************************************************************************/
package org.eclipse.cdt.ui.text.doctools.generic;

/**
 * Record class for a generic documentation tool tag.
 * @since 5.0
 */
public class GenericDocTag {
	protected final String name, description;
	
	/**
	 * Create a tag
	 * @param name
	 * @param description
	 */
	public GenericDocTag(String name, String description) {
		this.name= name;
		this.description= description;
	}
	
	/**
	 * @return the tag name (without any prefix e.g. no at or backslash)
	 */
	public String getTagName() {
		return name;
	}
	
	/**
	 * @return a human readable description of the tag. May be null.
	 */
	public String getTagDescription() {
		return description;
	}
}