Skip to content

Commit 5d1da71

Browse files
oschwaldclaude
andcommitted
fixup! Clarify MMDB_get_entry_data_list start parameter
Fix parameter description to say "pointer to an MMDB_entry_s struct" instead of "an MMDB_entry_s value" since the C parameter is a pointer. Apply the same fix to the data lookup functions description. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent abe7267 commit 5d1da71

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

doc/libmaxminddb.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ typedef struct MMDB_entry_data_list_s {
9292
9393
# DESCRIPTION
9494
95-
The libmaxminddb library provides functions for working with MaxMind DB files. See
96-
https://maxmind.github.io/MaxMind-DB/ for the MaxMind DB format
95+
The libmaxminddb library provides functions for working with MaxMind DB files.
96+
See https://maxmind.github.io/MaxMind-DB/ for the MaxMind DB format
9797
specification. The database and results are all represented by different
9898
data structures. Databases are opened by calling `MMDB_open()`. You can
9999
look up IP addresses as a string with `MMDB_lookup_string()` or as a
@@ -556,9 +556,9 @@ int MMDB_aget_value(
556556
The three functions allow three slightly different calling styles, but they
557557
all do the same thing.
558558
559-
The first parameter is an `MMDB_entry_s` value. In most cases this will come
560-
from the `MMDB_lookup_result_s` value returned by `MMDB_lookup_string()` or
561-
`MMDB_lookup_sockaddr()`.
559+
The first parameter is a pointer to an `MMDB_entry_s` struct. In most cases
560+
this will be a pointer to the `entry` field of the `MMDB_lookup_result_s`
561+
value returned by `MMDB_lookup_string()` or `MMDB_lookup_sockaddr()`.
562562
563563
The second parameter is a reference to an `MMDB_entry_data_s` structure. This
564564
will be populated with the data that is being looked up, if any is found. If
@@ -631,9 +631,9 @@ int MMDB_get_entry_data_list(
631631
MMDB_entry_data_list_s **const entry_data_list);
632632
```
633633

634-
The `start` parameter is an `MMDB_entry_s` value. In most cases this will come
635-
from the `entry` field of the `MMDB_lookup_result_s` value returned by
636-
`MMDB_lookup_string()` or `MMDB_lookup_sockaddr()`.
634+
The `start` parameter is a pointer to an `MMDB_entry_s` struct. In most cases
635+
this will be a pointer to the `entry` field of the `MMDB_lookup_result_s`
636+
value returned by `MMDB_lookup_string()` or `MMDB_lookup_sockaddr()`.
637637

638638
This function allows you to get all of the data for a complex data structure
639639
at once, rather than looking up each piece using repeated calls to

0 commit comments

Comments
 (0)