Skip to content

Commit 3120c26

Browse files
finch04JackLau1222
authored andcommitted
api_in_cpp/jsonparam:fix typos
1 parent 5d42338 commit 3120c26

File tree

2 files changed

+42
-40
lines changed
  • content
    • en/docs/bmf/api/api_in_cpp/jsonparam
    • zh/docs/bmf/api/api_in_cpp/jsonparam

2 files changed

+42
-40
lines changed

content/en/docs/bmf/api/api_in_cpp/jsonparam/_index.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ weight: 4
77
[//]: <> (REF_MD: classJsonParam.html)
88

99

10-
[Public Member Functions](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-member-functions) | [Public Attributes](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-attributes) | [List of all members](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/) # JsonParam Class Reference
10+
[Public Member Functions](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-member-functions) | [Public Attributes](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-attributes) | [List of all members](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/)
1111

12-
json_param.h ## Public Member Functions
12+
# JsonParam Class Reference
13+
14+
json_param.h
15+
16+
## Public Member Functions
1317

1418

1519
[JsonParam](#jsonparam-14) ()=default
@@ -105,7 +109,7 @@ void [merge_patch](#merge_patch) (const [JsonParam](https://babitmf.github.io/
105109
```
106110
JsonParam::JsonParam ( )
107111
```
108-
defaultdefault
112+
default
109113

110114

111115

@@ -141,7 +145,7 @@ JsonParam::JsonParam ( std::string opt_str )
141145
```
142146
JsonParam::JsonParam ( bmf_nlohmann::json json_value )
143147
```
144-
explicitexplicit
148+
explicit
145149

146150

147151

@@ -187,18 +191,17 @@ erase the key content from json param
187191
```
188192
T JsonParam::get ( U name ) const
189193
```
190-
inlineinline
194+
inline
191195

192196

193197

194198

195199

196200

197201
```
198-
  {
199-
  return json_value_[name].template get<T>();
200-
  }
201-
202+
{
203+
return json_value_[name].template get<T>();
204+
}
202205
```
203206

204207
###  get_double()
@@ -231,7 +234,7 @@ get double value list according to the key name
231234

232235
**Parameters**
233236
- **name** name of key
234-
- **result** result of doule list
237+
- **result** result of double list
235238

236239

237240

@@ -476,18 +479,17 @@ merge json patch to current target
476479
```
477480
JsonParam JsonParam::operator[]( T name )
478481
```
479-
inlineinline
482+
inline
480483

481484

482485

483486

484487

485488

486489
```
487-
  {
488-
  return JsonParam(json_value_[name]);
489-
  }
490-
490+
{
491+
return JsonParam(json_value_[name]);
492+
}
491493
```
492494

493495
###  parse()
@@ -540,18 +542,17 @@ store json content to file
540542
```
541543
T JsonParam::to ( ) const
542544
```
543-
inlineinline
545+
inline
544546

545547

546548

547549

548550

549551

550552
```
551-
  {
552-
  return json_value_.get<T>();
553-
  }
554-
553+
{
554+
return json_value_.get<T>();
555+
}
555556
```
556557
## Member Data Documentation
557558

content/zh/docs/bmf/api/api_in_cpp/jsonparam/_index.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ weight: 4
77
[//]: <> (REF_MD: classJsonParam.html)
88

99

10-
[公有成员函数](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-member-functions) | [公共属性](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-attributes) | [成员清单](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/) # JsonParam Class Reference
10+
[公有成员函数](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-member-functions) | [公共属性](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/#public-attributes) | [成员清单](https://babitmf.github.io/docs/bmf/api/api_in_cpp/jsonparam/)
11+
12+
# JsonParam Class Reference
1113

12-
json_param.h ## Public Member Functions
14+
json_param.h
15+
16+
## Public Member Functions
1317

1418

1519
[JsonParam](#jsonparam-14) ()=default
@@ -105,7 +109,7 @@ void [merge_patch](#merge_patch) (const [JsonParam](https://babitmf.github.io/
105109
```
106110
JsonParam::JsonParam ( )
107111
```
108-
defaultdefault
112+
default
109113

110114

111115

@@ -141,7 +145,7 @@ JsonParam::JsonParam ( std::string opt_str )
141145
```
142146
JsonParam::JsonParam ( bmf_nlohmann::json json_value )
143147
```
144-
explicitexplicit
148+
explicit
145149

146150

147151

@@ -187,18 +191,17 @@ int JsonParam::erase ( std::string name )
187191
```
188192
T JsonParam::get ( U name ) const
189193
```
190-
inlineinline
194+
inline
191195

192196

193197

194198

195199

196200

197201
```
198-
  {
199-
  return json_value_[name].template get<T>();
200-
  }
201-
202+
{
203+
return json_value_[name].template get<T>();
204+
}
202205
```
203206

204207
###  get_double()
@@ -231,7 +234,7 @@ int JsonParam::get_double_list ( std::string name,
231234

232235
**Parameters**
233236
- **name**:key 的名称
234-
- **result** doule list 的结果
237+
- **result** double list 的结果
235238

236239

237240

@@ -476,18 +479,17 @@ void JsonParam::merge_patch ( const JsonParam &json_patch )
476479
```
477480
JsonParam JsonParam::operator[]( T name )
478481
```
479-
inlineinline
482+
inline
480483

481484

482485

483486

484487

485488

486489
```
487-
  {
488-
  return JsonParam(json_value_[name]);
489-
  }
490-
490+
{
491+
return JsonParam(json_value_[name]);
492+
}
491493
```
492494

493495
###  parse()
@@ -540,18 +542,17 @@ int JsonParam::store ( std::string file_name )
540542
```
541543
T JsonParam::to ( ) const
542544
```
543-
inlineinline
545+
inline
544546

545547

546548

547549

548550

549551

550552
```
551-
  {
552-
  return json_value_.get<T>();
553-
  }
554-
553+
{
554+
return json_value_.get<T>();
555+
}
555556
```
556557
## 成员数据文档
557558

0 commit comments

Comments
 (0)