add func doc comments

This commit is contained in:
c9s 2024-07-02 14:47:36 +08:00
parent 0a6d24195b
commit bc12e88501
No known key found for this signature in database
GPG Key ID: 7385E7E464CB0A54

View File

@ -181,6 +181,8 @@ func (slice *PriceVolumeSlice) UnmarshalJSON(b []byte) error {
return nil
}
// ParsePriceVolumeKvSliceJSON parses a JSON array of objects into PriceVolumeSlice
// [{"Price":...,"Volume":...}, ...]
func ParsePriceVolumeKvSliceJSON(b []byte) (PriceVolumeSlice, error) {
type S PriceVolumeSlice
var ts S
@ -200,6 +202,8 @@ func ParsePriceVolumeKvSliceJSON(b []byte) (PriceVolumeSlice, error) {
// ParsePriceVolumeSliceJSON tries to parse a 2 dimensional string array into a PriceVolumeSlice
//
// [["9000", "10"], ["9900", "10"], ... ]
//
// if parse failed, then it will try to parse the JSON array of objects, function ParsePriceVolumeKvSliceJSON will be called.
func ParsePriceVolumeSliceJSON(b []byte) (slice PriceVolumeSlice, err error) {
var as [][]fixedpoint.Value