Add multi-word parameter name to test suite

And reference it from the docstring.
KhalilBellakrid · Jan 31, 2018 · 785a226 · 785a226
1 parent 961181a
commit 785a226
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 12 deletions.
diff --git a/test-suite/djinni/test.djinni b/test-suite/djinni/test.djinni
@@ -4,10 +4,12 @@
 test_helpers = interface +c {
     # Method with documentation
     static get_set_record(): set_record;
-    # Method with long documentation
+    # Method with long documentation & doxygen
     # (Second line of multi-line documentation.
     #   Indented third line of multi-line documentation.)
-    static check_set_record(rec: set_record): bool;
+    # @param the_record the record to check
+    # @return whether the record is okay
+    static check_set_record(the_record: set_record): bool;
 
     static get_primitive_list(): primitive_list;
     static check_primitive_list(pl: primitive_list): bool;

diff --git a/test-suite/generated-src/cpp/test_helpers.hpp b/test-suite/generated-src/cpp/test_helpers.hpp
@@ -34,11 +34,13 @@ class TestHelpers {
     static SetRecord get_set_record();
 
     /**
-     * Method with long documentation
+     * Method with long documentation & doxygen
      * (Second line of multi-line documentation.
      *   Indented third line of multi-line documentation.)
+     * @param the_record the record to check
+     * @return whether the record is okay
      */
-    static bool check_set_record(const SetRecord & rec);
+    static bool check_set_record(const SetRecord & the_record);
 
     static PrimitiveList get_primitive_list();
 

diff --git a/test-suite/generated-src/java/com/dropbox/djinni/test/TestHelpers.java b/test-suite/generated-src/java/com/dropbox/djinni/test/TestHelpers.java
@@ -19,11 +19,13 @@ public abstract class TestHelpers {
     public static native SetRecord getSetRecord();
 
     /**
-     * Method with long documentation
+     * Method with long documentation & doxygen
      * (Second line of multi-line documentation.
      *   Indented third line of multi-line documentation.)
+     * @param theRecord the record to check
+     * @return whether the record is okay
      */
-    public static native boolean checkSetRecord(@Nonnull SetRecord rec);
+    public static native boolean checkSetRecord(@Nonnull SetRecord theRecord);
 
     @Nonnull
     public static native PrimitiveList getPrimitiveList();

diff --git a/test-suite/generated-src/jni/NativeTestHelpers.cpp b/test-suite/generated-src/jni/NativeTestHelpers.cpp
@@ -36,11 +36,11 @@ CJNIEXPORT jobject JNICALL Java_com_dropbox_djinni_test_TestHelpers_getSetRecord
     } JNI_TRANSLATE_EXCEPTIONS_RETURN(jniEnv, 0 /* value doesn't matter */)
 }
 
-CJNIEXPORT jboolean JNICALL Java_com_dropbox_djinni_test_TestHelpers_checkSetRecord(JNIEnv* jniEnv, jobject /*this*/, jobject j_rec)
+CJNIEXPORT jboolean JNICALL Java_com_dropbox_djinni_test_TestHelpers_checkSetRecord(JNIEnv* jniEnv, jobject /*this*/, jobject j_theRecord)
 {
     try {
         DJINNI_FUNCTION_PROLOGUE0(jniEnv);
-        auto r = ::testsuite::TestHelpers::check_set_record(::djinni_generated::NativeSetRecord::toCpp(jniEnv, j_rec));
+        auto r = ::testsuite::TestHelpers::check_set_record(::djinni_generated::NativeSetRecord::toCpp(jniEnv, j_theRecord));
         return ::djinni::release(::djinni::Bool::fromCpp(jniEnv, r));
     } JNI_TRANSLATE_EXCEPTIONS_RETURN(jniEnv, 0 /* value doesn't matter */)
 }

diff --git a/test-suite/generated-src/objc/DBTestHelpers+Private.mm b/test-suite/generated-src/objc/DBTestHelpers+Private.mm
@@ -45,9 +45,9 @@ + (nonnull DBSetRecord *)getSetRecord {
     } DJINNI_TRANSLATE_EXCEPTIONS()
 }
 
-+ (BOOL)checkSetRecord:(nonnull DBSetRecord *)rec {
++ (BOOL)checkSetRecord:(nonnull DBSetRecord *)theRecord {
     try {
-        auto objcpp_result_ = ::testsuite::TestHelpers::check_set_record(::djinni_generated::SetRecord::toCpp(rec));
+        auto objcpp_result_ = ::testsuite::TestHelpers::check_set_record(::djinni_generated::SetRecord::toCpp(theRecord));
         return ::djinni::Bool::fromCpp(objcpp_result_);
     } DJINNI_TRANSLATE_EXCEPTIONS()
 }

diff --git a/test-suite/generated-src/objc/DBTestHelpers.h b/test-suite/generated-src/objc/DBTestHelpers.h
@@ -23,11 +23,13 @@
 + (nonnull DBSetRecord *)getSetRecord;
 
 /**
- * Method with long documentation
+ * Method with long documentation & doxygen
  * (Second line of multi-line documentation.
  *   Indented third line of multi-line documentation.)
+ * @param theRecord the record to check
+ * @return whether the record is okay
  */
-+ (BOOL)checkSetRecord:(nonnull DBSetRecord *)rec;
++ (BOOL)checkSetRecord:(nonnull DBSetRecord *)theRecord;
 
 + (nonnull DBPrimitiveList *)getPrimitiveList;