mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-09-10 12:03:16 +02:00
Code Issues Wiki Activity

Fixed JavaDoc.

Browse source
This commit is contained in:
Sergey Prigogin 2015-04-10 18:18:02 -07:00
parent 9ea9dd867c
commit 82821b7496
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexInclude.java
View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2013 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2015 Wind River Systems, Inc. and others.
* All rights reserved. This program and the accompanying materials * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -40,26 +40,25 @@ public interface IIndexInclude {
/** /**
* Returns the IIndexFileLocation of the file that is included by this * Returns the IIndexFileLocation of the file that is included by this
* directive. In case of an unresolved include <code>null</code> * directive. In case of an unresolved include {@code null}
* will be returned. * will be returned.
* *
* @return the IIndexFileLocation of the file that is included by this * @return the IIndexFileLocation of the file that is included by this directive or {@code null}
* directive or <code>null</code> if the include is unresolved or * if the include is unresolved or inactive
* inactive
* @throws CoreException * @throws CoreException
*/ */
IIndexFileLocation getIncludesLocation() throws CoreException; IIndexFileLocation getIncludesLocation() throws CoreException;
/** /**
* Returns the simple name of the directive. This skips any leading * Returns the simple name of the directive. This skips any leading
* directories. E.g.: for '<sys/types.h>' 'types.h' will be returned. * directories. E.g. for {@code <sys/types.h>} {@code "types.h"} will be returned.
* @throws CoreException * @throws CoreException
*/ */
String getName() throws CoreException; String getName() throws CoreException;
/** /**
* Returns the name of the include. The name does not include the enclosing quotes * Returns the name of the include. The name does not include the enclosing quotes
* or angle brackets. E.g.: for '<sys/types.h>' 'sys/types.h' will be returned. * or angle brackets. E.g. for {@code <sys/types.h>} {@code "sys/types.h"} will be returned.
* @throws CoreException * @throws CoreException
* @since 5.1 * @since 5.1
*/ */