Skip to content

Commit 90324f5

Browse files
oschwaldclaude
andcommitted
Update function signatures to match header const qualifiers
The documentation showed MMDB_s *const mmdb but the header declares const MMDB_s *const mmdb for these functions. Update both the SYNOPSIS and individual function sections for: - MMDB_lookup_string - MMDB_lookup_sockaddr - MMDB_read_node - MMDB_get_metadata_as_entry_data_list Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent beac8df commit 90324f5

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
@@ -14,12 +14,12 @@ int MMDB_open(
1414
void MMDB_close(MMDB_s *const mmdb);
1515

1616
MMDB_lookup_result_s MMDB_lookup_string(
17-
MMDB_s *const mmdb,
17+
const MMDB_s *const mmdb,
1818
const char *const ipstr,
1919
int *const gai_error,
2020
int *const mmdb_error);
2121
MMDB_lookup_result_s MMDB_lookup_sockaddr(
22-
MMDB_s *const mmdb,
22+
const MMDB_s *const mmdb,
2323
const struct sockaddr *const
2424
sockaddr,
2525
int *const mmdb_error);
@@ -43,15 +43,15 @@ int MMDB_get_entry_data_list(
4343
void MMDB_free_entry_data_list(
4444
MMDB_entry_data_list_s *const entry_data_list);
4545
int MMDB_get_metadata_as_entry_data_list(
46-
MMDB_s *const mmdb,
46+
const MMDB_s *const mmdb,
4747
MMDB_entry_data_list_s **const entry_data_list);
4848
int MMDB_dump_entry_data_list(
4949
FILE *const stream,
5050
MMDB_entry_data_list_s *const entry_data_list,
5151
int indent);
5252

5353
int MMDB_read_node(
54-
MMDB_s *const mmdb,
54+
const MMDB_s *const mmdb,
5555
uint32_t node_number,
5656
MMDB_search_node_s *const node);
5757

@@ -463,7 +463,7 @@ freeing it.
463463

464464
```c
465465
MMDB_lookup_result_s MMDB_lookup_string(
466-
MMDB_s *const mmdb,
466+
const MMDB_s *const mmdb,
467467
const char *const ipstr,
468468
int *const gai_error,
469469
int *const mmdb_error);
@@ -510,7 +510,7 @@ If you pass an IPv6 address to a database with only IPv4 data then the
510510

511511
```c
512512
MMDB_lookup_result_s MMDB_lookup_sockaddr(
513-
MMDB_s *const mmdb,
513+
const MMDB_s *const mmdb,
514514
const struct sockaddr *const sockaddr,
515515
int *const mmdb_error);
516516
```
@@ -698,7 +698,7 @@ function to free the `MMDB_entry_data_list_s` structure.
698698
699699
```c
700700
int MMDB_get_metadata_as_entry_data_list(
701-
MMDB_s *const mmdb,
701+
const MMDB_s *const mmdb,
702702
MMDB_entry_data_list_s **const entry_data_list);
703703
```
704704

@@ -750,7 +750,7 @@ The return value of the function is a status code as defined above.
750750

751751
```c
752752
int MMDB_read_node(
753-
MMDB_s *const mmdb,
753+
const MMDB_s *const mmdb,
754754
uint32_t node_number,
755755
MMDB_search_node_s *const node);
756756
```

0 commit comments

Comments
 (0)