Skip to content

Commit ab7af2b

Browse files
[SWIG] Port all possible methods from Subrepresentation and GridConnectionSetRepresentation
{JAVA] Fix SWIG warning with JAVADOC {JAVA] Do no more ignore parameter flagged as "in" and/or "out" in JAVADOC
1 parent 2a8e597 commit ab7af2b

File tree

250 files changed

+2504
-2165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

250 files changed

+2504
-2165
lines changed

src/common/AbstractObject.h

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ namespace COMMON_NS
103103
DLL_IMPORT_OR_EXPORT time_t getCreation() const;
104104

105105
/**
106-
* Same as {@link getCreation()}. Please use this method if you want to read some dates out of
106+
* Same as \link getCreation() \endlink. Please use this method if you want to read some dates out of
107107
* the range of @c time_t
108108
*
109109
* @exception std::invalid_argument If this instance is actually a partial object or if no
@@ -153,7 +153,7 @@ namespace COMMON_NS
153153
DLL_IMPORT_OR_EXPORT time_t getLastUpdate() const;
154154

155155
/**
156-
* Same as {@link getLastUpdate()}. Please use this method if you want to read some dates out of
156+
* Same as \link getLastUpdate() \endlink. Please use this method if you want to read some dates out of
157157
* the range of @c time_t
158158
*
159159
* @exception std::invalid_argument If this instance is actually a partial object.
@@ -236,7 +236,7 @@ namespace COMMON_NS
236236
DLL_IMPORT_OR_EXPORT void setCreation(time_t creation);
237237

238238
/**
239-
* Same as {@link setCreation()}. Please use this method if you want to set some dates out of
239+
* Same as \link setCreation() \endlink. Please use this method if you want to set some dates out of
240240
* the range of @c time_t
241241
*
242242
* @exception std::invalid_argument If this instance is actually a partial object.
@@ -286,7 +286,7 @@ namespace COMMON_NS
286286
DLL_IMPORT_OR_EXPORT void setLastUpdate(time_t lastUpdate);
287287

288288
/**
289-
* Same as {@link setLastUpdate()}. Please use this method if you want to read some dates out of
289+
* Same as \link setLastUpdate() \endlink. Please use this method if you want to read some dates out of
290290
* the range of @c time_t
291291
*
292292
* @param lastUpdate The last update date and time to set to this data object.
@@ -367,7 +367,7 @@ namespace COMMON_NS
367367
* @exception std::invalid_argument If this instance is actually a partial object or if @p
368368
* stream is null.
369369
*
370-
* @param [out] stream A stream. It must be opened for writing and won't be closed.
370+
* @param[out] stream A stream. It must be opened for writing and won't be closed.
371371
*/
372372
DLL_IMPORT_OR_EXPORT void serializeIntoStream(std::ostream * stream);
373373

@@ -380,7 +380,7 @@ namespace COMMON_NS
380380
/**
381381
* Sets the underlying RESQML2.0 gSOAP proxy of this data object
382382
*
383-
* @param [in] gsoapProxy If non-null, the gSOAP proxy.
383+
* @param[in] gsoapProxy If non-null, the gSOAP proxy.
384384
*/
385385
void setGsoapProxy(gsoap_resqml2_0_1::eml20__AbstractCitedDataObject* gsoapProxy) { gsoapProxy2_0_1 = gsoapProxy; }
386386

@@ -393,7 +393,7 @@ namespace COMMON_NS
393393
/**
394394
* Sets the underlying EML2.3 gSOAP proxy of this data object
395395
*
396-
* @param [in] gsoapProxy If non-null, the gSOAP proxy.
396+
* @param[in] gsoapProxy If non-null, the gSOAP proxy.
397397
*/
398398
void setGsoapProxy(gsoap_eml2_3::eml23__AbstractObject* gsoapProxy) { gsoapProxy2_3 = gsoapProxy; }
399399

@@ -709,7 +709,7 @@ namespace COMMON_NS
709709
/**
710710
* Constructor for partial transfer
711711
*
712-
* @param [in,out] partialObject_ If non-null, the partial object.
712+
* @param[in,out] partialObject_ If non-null, the partial object.
713713
*/
714714
AbstractObject(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject_) :
715715
partialObject(partialObject_),
@@ -725,7 +725,7 @@ namespace COMMON_NS
725725
/**
726726
* Constructor when importing EML 2.0 (i.e RESQML2.0.1) dataobjects
727727
*
728-
* @param [in,out] proxy If non-null, the proxy.
728+
* @param[in,out] proxy If non-null, the proxy.
729729
*/
730730
AbstractObject(gsoap_resqml2_0_1::eml20__AbstractCitedDataObject* proxy) :
731731
partialObject(nullptr),
@@ -736,7 +736,7 @@ namespace COMMON_NS
736736
/**
737737
* Constructor when importing EML 2.3 dataobjects
738738
*
739-
* @param [in,out] proxy If non-null, the proxy.
739+
* @param[in,out] proxy If non-null, the proxy.
740740
*/
741741
AbstractObject(gsoap_eml2_3::eml23__AbstractObject* proxy) :
742742
partialObject(nullptr),
@@ -783,35 +783,35 @@ namespace COMMON_NS
783783
* Read an input array which come from EML 2.0 (and potentially HDF5) and store it into a
784784
* preallocated output array in memory. It does not allocate or deallocate memory.
785785
*
786-
* @param [in] arrayInput If non-null, the array input.
787-
* @param [out] arrayOutput If non-null, the array output.
786+
* @param[in] arrayInput If non-null, the array input.
787+
* @param[out] arrayOutput If non-null, the array output.
788788
*/
789789
DLL_IMPORT_OR_EXPORT void readArrayNdOfFloatValues(gsoap_resqml2_0_1::resqml20__AbstractDoubleArray const* arrayInput, float* arrayOutput) const;
790790

791791
/**
792792
* Read an input array which come from EML 2.3 (and potentially HDF5) and store it into a
793793
* preallocated output array in memory. It does not allocate or deallocate memory.
794794
*
795-
* @param [in] arrayInput If non-null, the array input.
796-
* @param [out] arrayOutput If non-null, the array output.
795+
* @param[in] arrayInput If non-null, the array input.
796+
* @param[out] arrayOutput If non-null, the array output.
797797
*/
798798
DLL_IMPORT_OR_EXPORT void readArrayNdOfFloatValues(gsoap_eml2_3::eml23__AbstractFloatingPointArray const* arrayInput, float* arrayOutput) const;
799799

800800
/**
801801
* Read an input array which come from EML 2.0 (and potentially HDF5) and store it into a
802802
* preallocated output array in memory. It does not allocate or deallocate memory.
803803
*
804-
* @param [in] arrayInput If non-null, the array input.
805-
* @param [out] arrayOutput If non-null, the array output.
804+
* @param[in] arrayInput If non-null, the array input.
805+
* @param[out] arrayOutput If non-null, the array output.
806806
*/
807807
DLL_IMPORT_OR_EXPORT void readArrayNdOfDoubleValues(gsoap_resqml2_0_1::resqml20__AbstractDoubleArray const* arrayInput, double * arrayOutput) const;
808808

809809
/**
810810
* Read an input array which come from EML 2.3 (and potentially HDF5) and store it into a
811811
* preallocated output array in memory. It does not allocate or deallocate memory.
812812
*
813-
* @param [in] arrayInput If non-null, the array input.
814-
* @param [out] arrayOutput If non-null, the array output.
813+
* @param[in] arrayInput If non-null, the array input.
814+
* @param[out] arrayOutput If non-null, the array output.
815815
*/
816816
DLL_IMPORT_OR_EXPORT void readArrayNdOfDoubleValues(gsoap_eml2_3::eml23__AbstractFloatingPointArray const* arrayInput, double * arrayOutput) const;
817817

@@ -961,8 +961,8 @@ namespace COMMON_NS
961961
* Read an input array which come from EML 2.0 (and potentially HDF5) and store it into a
962962
* preallocated output array in memory. It does not allocate or deallocate memory.
963963
*
964-
* @param [in] arrayInput If non-null, the array input.
965-
* @param [out] arrayOutput If non-null, the array output.
964+
* @param[in] arrayInput If non-null, the array input.
965+
* @param[out] arrayOutput If non-null, the array output.
966966
*
967967
* @returns The null value of this array. Default returned value is uint16_t::max
968968
*/
@@ -972,8 +972,8 @@ namespace COMMON_NS
972972
* Read an input array which come from EML 2.0 (and potentially HDF5) and store it into a
973973
* preallocated output array in memory. It does not allocate or deallocate memory.
974974
*
975-
* @param [in] arrayInput If non-null, the array input.
976-
* @param [out] arrayOutput If non-null, the array output.
975+
* @param[in] arrayInput If non-null, the array input.
976+
* @param[out] arrayOutput If non-null, the array output.
977977
*
978978
* @returns The null value of this array. Default returned value is the max numeric limits of T.
979979
*/
@@ -984,8 +984,8 @@ namespace COMMON_NS
984984
* Read an input array which come from EML 2.3 (and potentially HDF5) and store it into a
985985
* preallocated output array in memory. It does not allocate or deallocate memory.
986986
*
987-
* @param [in] arrayInput If non-null, the array input.
988-
* @param [out] arrayOutput If non-null, the array output.
987+
* @param[in] arrayInput If non-null, the array input.
988+
* @param[out] arrayOutput If non-null, the array output.
989989
*
990990
* @returns The null value of this array. Default returned value is the max numeric limits of T.
991991
*/
@@ -995,7 +995,7 @@ namespace COMMON_NS
995995
/**
996996
* Get the count of item in an array of integer
997997
*
998-
* @param [in,out] arrayInput The array of integer.
998+
* @param[in,out] arrayInput The array of integer.
999999
*
10001000
* @returns The count of item in the array of integer.
10011001
*/
@@ -1004,7 +1004,7 @@ namespace COMMON_NS
10041004
/**
10051005
* Get the count of item in an array
10061006
*
1007-
* @param [in,out] arrayInput The array.
1007+
* @param[in,out] arrayInput The array.
10081008
*
10091009
* @returns The count of item in the array.
10101010
*/

src/common/DataObjectReference.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,21 @@ namespace COMMON_NS
5656
/**
5757
* Constructor
5858
*
59-
* @param [in] dor If non-nullptr, the EML2.0 DOR to wrap.
59+
* @param[in] dor If non-nullptr, the EML2.0 DOR to wrap.
6060
*/
6161
DataObjectReference(gsoap_resqml2_0_1::eml20__DataObjectReference * dor): dor20(dor), dor23(nullptr) {}
6262

6363
/**
6464
* Constructor
6565
*
66-
* @param [in,out] dor If non-nullptr, the EML2.3 DOR to wrap.
66+
* @param[in,out] dor If non-nullptr, the EML2.3 DOR to wrap.
6767
*/
6868
DataObjectReference(gsoap_eml2_3::eml23__DataObjectReference * dor) : dor20(nullptr), dor23(dor) {}
6969

7070
/**
7171
* Constructor
7272
*
73-
* @param [in,out] dataObj If non-nullptr, the Energistics DataObject to wrap.
73+
* @param[in,out] dataObj If non-nullptr, the Energistics DataObject to wrap.
7474
*/
7575
explicit DataObjectReference(AbstractObject const * dataObj);
7676

0 commit comments

Comments
 (0)