Correct optimize() comment.

svn path=/trunk/yasm/; revision=470

diff --git a/libyasm/optimizer.h b/libyasm/optimizer.h
index c39e6648e3156cf0891eb422bf3afd3092ebabec..b5136cb00e35c43d8e8448f71155e631bef8eab1 100644 (file)
--- a/libyasm/optimizer.h
+++ b/libyasm/optimizer.h
@@ -32,8 +32,10 @@ struct optimizer {
 
     /* Main entrance point for the optimizer.
      *
-     * This function takes the unoptimized linked list of sections and returns
-     * an optimized linked list of sections ready for output to an object file.
+     * This function takes the unoptimized linked list of sections and
+     * optimizes it.  If successful, the sections are ready for output to an
+     * object file.  (A failure is indicated by calling ErrorAt() from within
+     * this function).
      */
     void (*optimize) (sectionhead *sections);
 };

diff --git a/src/optimizer.h b/src/optimizer.h
index c39e6648e3156cf0891eb422bf3afd3092ebabec..b5136cb00e35c43d8e8448f71155e631bef8eab1 100644 (file)
--- a/src/optimizer.h
+++ b/src/optimizer.h
@@ -32,8 +32,10 @@ struct optimizer {
 
     /* Main entrance point for the optimizer.
      *
-     * This function takes the unoptimized linked list of sections and returns
-     * an optimized linked list of sections ready for output to an object file.
+     * This function takes the unoptimized linked list of sections and
+     * optimizes it.  If successful, the sections are ready for output to an
+     * object file.  (A failure is indicated by calling ErrorAt() from within
+     * this function).
      */
     void (*optimize) (sectionhead *sections);
 };