[prettyfaces] r457 committed - Fixed Javadocs for PrettyFaces.sendError()

[prett...@googlecode.com]

Revision: 457
Author: chkalt
Date: Mon Oct 18 23:14:56 2010
Log: Fixed Javadocs for PrettyFaces.sendError()
http://code.google.com/p/prettyfaces/source/detail?r=457

Modified:
/prettyfaces/trunk/core/src/main/java/com/ocpsoft/pretty/PrettyContext.java

=======================================
---
/prettyfaces/trunk/core/src/main/java/com/ocpsoft/pretty/PrettyContext.java
Mon Oct 18 09:56:19 2010
+++
/prettyfaces/trunk/core/src/main/java/com/ocpsoft/pretty/PrettyContext.java
Mon Oct 18 23:14:56 2010
@@ -305,8 +305,17 @@
}

/**
+ * <p>
* Sends an error response to the client using the specified HTTP status
* code.
+ * </p>
+ * <p>
+ * Please note that this method can only be called from within the JSF
+ * lifecycle as it needs the {@link FacesContext} to obtain the
+ * {@link HttpServletResponse}. Please use
+ * {@link #sendError(int, String, HttpServletResponse)} in all other
+ * cases.
+ * </p>
*
* @param code the error status code
* @see HttpServletResponse#sendError(int, String)
@@ -317,8 +326,17 @@
}

/**
+ * <p>
* Sends an error response to the client using the specified HTTP status
* code.
+ * </p>
+ * <p>
+ * Please note that this method can only be called from within the JSF
+ * lifecycle as it needs the {@link FacesContext} to obtain the
+ * {@link HttpServletResponse}. Please use
+ * {@link #sendError(int, String, HttpServletResponse)} in all other
+ * cases.
+ * </p>
*
* @param code the error status code
* @param message the descriptive message