From 14991a390a4c058696e154df5e3c7f67cef2805b Mon Sep 17 00:00:00 2001
From: Andrew Gvozdev <angvoz.dev@gmail.com>
Date: Sun, 10 Oct 2010 18:01:56 +0000
Subject: [PATCH] Some Javadoc for ICLanguageSettingEntry interfaces

---
 .../cdt/core/settings/model/ICIncludeFileEntry.java       | 4 ++++
 .../cdt/core/settings/model/ICIncludePathEntry.java       | 4 ++++
 .../cdt/core/settings/model/ICLanguageSettingEntry.java   | 7 ++++++-
 .../core/settings/model/ICLanguageSettingPathEntry.java   | 5 +++++
 .../cdt/core/settings/model/ICLibraryFileEntry.java       | 4 ++++
 .../cdt/core/settings/model/ICLibraryPathEntry.java       | 4 ++++
 .../org/eclipse/cdt/core/settings/model/ICMacroEntry.java | 8 ++++++++
 .../eclipse/cdt/core/settings/model/ICMacroFileEntry.java | 5 +++++
 .../org/eclipse/cdt/core/settings/model/ICPathEntry.java  | 5 +++++
 9 files changed, 45 insertions(+), 1 deletion(-)

diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludeFileEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludeFileEntry.java
index d8cac43b9f2..95d1e843653 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludeFileEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludeFileEntry.java
@@ -10,6 +10,10 @@
  *******************************************************************************/
 package org.eclipse.cdt.core.settings.model;
 
+/**
+ * Representation in the project model of language settings entries
+ * such as include files ({@code -include file} gcc option). See {@link ICSettingEntry#INCLUDE_FILE}.
+ */
 public interface ICIncludeFileEntry extends ICLanguageSettingPathEntry {
 
 }
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludePathEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludePathEntry.java
index 07d3efef7ff..09a58628cb5 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludePathEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICIncludePathEntry.java
@@ -10,6 +10,10 @@
  *******************************************************************************/
 package org.eclipse.cdt.core.settings.model;
 
+/**
+ * Representation in the project model of language settings entries
+ * include paths (-I). See {@link ICSettingEntry#INCLUDE_PATH}.
+ */
 public interface ICIncludePathEntry extends ICLanguageSettingPathEntry {
 	boolean isLocal();
 }
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingEntry.java
index 8e577021ce5..5eafbacba46 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingEntry.java
@@ -10,5 +10,10 @@
  *******************************************************************************/
 package org.eclipse.cdt.core.settings.model;
 
-public interface ICLanguageSettingEntry extends ICSettingEntry{
+/**
+ * Representation in the project model of language settings entries
+ * such as include paths (-I) or preprocessor defines (-D) and others (see
+ * {@link ICSettingEntry#INCLUDE_PATH} and other kinds).
+ */
+public interface ICLanguageSettingEntry extends ICSettingEntry {
 }
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingPathEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingPathEntry.java
index ff0a799f1cf..17eda3d4da0 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingPathEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLanguageSettingPathEntry.java
@@ -10,5 +10,10 @@
  *******************************************************************************/
 package org.eclipse.cdt.core.settings.model;
 
+/**
+ * Representation in the project model of language settings entries of
+ * path-kind such as include paths (-I) or include files and others.
+ * See interface hierarchy for more specifics.
+ */
 public interface ICLanguageSettingPathEntry extends ICLanguageSettingEntry, ICPathEntry {
 }
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryFileEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryFileEntry.java
index 99b4e80565b..f6d72075582 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryFileEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryFileEntry.java
@@ -12,6 +12,10 @@ package org.eclipse.cdt.core.settings.model;
 
 import org.eclipse.core.runtime.IPath;
 
+/**
+ * Representation in the project model of language settings entries
+ * such as library file (-l gcc option). See {@link ICSettingEntry#LIBRARY_FILE}.
+ */
 public interface ICLibraryFileEntry extends ICLanguageSettingPathEntry {
 
 	/**
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryPathEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryPathEntry.java
index 0aa6a7dc40e..13e3de8060d 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryPathEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICLibraryPathEntry.java
@@ -10,6 +10,10 @@
  *******************************************************************************/
 package org.eclipse.cdt.core.settings.model;
 
+/**
+ * Representation in the project model of language settings entries
+ * such as library path (-L gcc option). See {@link ICSettingEntry#LIBRARY_PATH}.
+ */
 public interface ICLibraryPathEntry extends ICLanguageSettingPathEntry {
 
 }
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroEntry.java
index 30ca542f252..64004033c9a 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroEntry.java
@@ -10,6 +10,14 @@
  *******************************************************************************/
 package org.eclipse.cdt.core.settings.model;
 
+/**
+ * Representation in the project model of language settings entries having
+ * name-value attributes such as preprocessor defines (-D).
+ * See {@link ICSettingEntry#MACRO}.
+ */
 public interface ICMacroEntry extends ICLanguageSettingEntry {
+	/* (non-Javadoc)
+	 * @see org.eclipse.cdt.core.settings.model.ICSettingEntry#getValue()
+	 */
 	String getValue();
 }
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroFileEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroFileEntry.java
index 2c777bdfb66..43eaf04112c 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroFileEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICMacroFileEntry.java
@@ -10,6 +10,11 @@
  *******************************************************************************/
 package org.eclipse.cdt.core.settings.model;
 
+/**
+ * Representation in the project model of language settings entries
+ * such as macro file ({@code -imacros file} gcc option).
+ * See {@link ICSettingEntry#MACRO_FILE}.
+ */
 public interface ICMacroFileEntry extends ICLanguageSettingPathEntry {
 
 }
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICPathEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICPathEntry.java
index ab656ed8931..81bb7e5a7a4 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICPathEntry.java
+++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICPathEntry.java
@@ -12,6 +12,11 @@ package org.eclipse.cdt.core.settings.model;
 
 import org.eclipse.core.runtime.IPath;
 
+/**
+ * Helper interface capturing 'path' characteristic for {@link ICSettingEntry}
+ * and {@link ICLanguageSettingEntry} interfaces.
+ *
+ */
 public interface ICPathEntry extends ICSettingEntry {
 	IPath getFullPath();