[Cbe-oss-dev] [PATCH 1/3] libspe: fix doc params

[Dirk Herrendoerfer]

Patch to fix warning messages from doxygen when the @param name does  
not match
the actual parameter name. Also added the clean up of the doc/img files.

Signed-off-by: Brian Watt <bwatt at us.ibm.com>
Acked-by: Dirk Herrendoerfer <d.herrendoerfer [at] de [dot] ibm [dot]  
com>

diff -uprN libspe2.orig/doc/img/Makefile libspe2.fix_doc_params/doc/ 
img/Makefile
--- libspe2.orig/doc/img/Makefile	2009-06-25 17:17:45.000000000 -0500
+++ libspe2.fix_doc_params/doc/img/Makefile	2009-06-25  
17:13:09.000000000 -0500
@@ -9,4 +9,4 @@ $(images): %.pdf: %.dot


  clean:
-	rm $(images)
\ No newline at end of file
+	-rm $(images)
\ No newline at end of file
diff -uprN libspe2.orig/Makefile libspe2.fix_doc_params/Makefile
--- libspe2.orig/Makefile	2009-06-25 17:23:03.000000000 -0500
+++ libspe2.fix_doc_params/Makefile	2009-06-25 15:52:51.000000000 -0500
@@ -196,7 +196,7 @@ apiref: clean



-clean: base-clean event-clean elfspe-clean libspe12-clean tests-clean
+clean: base-clean event-clean elfspe-clean libspe12-clean tests-clean  
apiref-clean
  	rm *.diff ; true
  	rm -rf $(libspe2_A) $(libspe2_SO) $(libspe2_OBJS)
  	rm -f libspe2.so $(libspe2_SONAME)
@@ -228,6 +228,9 @@ libspe12-clean:
  tests-clean:
  	$(MAKE) -C tests clean

+apiref-clean:
+	$(MAKE) -C doc/img clean
+
  distclean: clean
  	$(MAKE) -C tests distclean
  	rm -rf latex
diff -uprN libspe2.orig/spebase/load.c libspe2.fix_doc_params/spebase/ 
load.c
--- libspe2.orig/spebase/load.c	2009-06-25 17:19:02.000000000 -0500
+++ libspe2.fix_doc_params/spebase/load.c	2009-06-25  
16:49:02.000000000 -0500
@@ -95,7 +95,7 @@ static inline int __write_isolated_load_
   *
   * Helper function for internal libspe use.
   *
- * @param thread The SPE thread to load the app to
+ * @param spe The SPE thread to load the app to
   * @param handle The handle to the spe program
   * @return zero on success, non-zero on failure;
   */
@@ -171,7 +171,7 @@ int _base_spe_emulated_loader_present(vo
   *
   * Helper function for internal libspe use.
   *
- * @param thread The SPE thread to load the app to
+ * @param spe The SPE thread to load the app to
   * @param handle The handle to the (isolated) spe program
   * @param ld_info[out] Loader information about the entry point of  
the SPE.
   *		This will reference the loader, not the SPE program, as
diff -uprN libspe2.orig/spebase/spebase.h libspe2.fix_doc_params/ 
spebase/spebase.h
--- libspe2.orig/spebase/spebase.h	2009-06-25 17:30:22.000000000 -0500
+++ libspe2.fix_doc_params/spebase/spebase.h	2009-06-25  
17:30:22.000000000 -0500
@@ -250,8 +250,10 @@ extern int _base_spe_gang_context_destro
   *
   * @param envp An (optional) pointer to environment specific data,  
and is passed as the third
   * parameter to the SPE program.
+ *
+ * @param stopinfo An (optional) pointer to a structure of type  
spe_stop_info_t.
   */
-extern int _base_spe_context_run(spe_context_ptr_t spe, unsigned int  
*entry,
+extern int _base_spe_context_run(spe_context_ptr_t spectx, unsigned  
int *entry,
  					unsigned int runflags, void *argp, void *envp, spe_stop_info_t  
*stopinfo);

  /**
@@ -677,7 +679,7 @@ void* _base_spe_ls_area_get(struct spe_c
   *
   * @param spectx Specifies the SPE context
   */
-int _base_spe_ls_size_get(spe_context_ptr_t spe);
+int _base_spe_ls_size_get(spe_context_ptr_t spectx);

  /**
   * _base_spe_context_lock locks members of the SPE context
@@ -685,7 +687,7 @@ int _base_spe_ls_size_get(spe_context_pt
   * @param spectx Specifies the SPE context
   * @param fd Specifies the file
   */
-void _base_spe_context_lock(spe_context_ptr_t spe, enum fd_name fd);
+void _base_spe_context_lock(spe_context_ptr_t spectx, enum fd_name fd);

  /**
   * _base_spe_context_unlock unlocks members of the SPE context
@@ -693,7 +695,7 @@ void _base_spe_context_lock(spe_context_
   * @param spectx Specifies the SPE context
   * @param fd Specifies the file
   */
-void _base_spe_context_unlock(spe_context_ptr_t spe, enum fd_name fd);
+void _base_spe_context_unlock(spe_context_ptr_t spectx, enum fd_name  
fd);

  /**
   * _base_spe_info_get