[pcre-dev] [Bug 2285] New: Document tolerance for null point…

https://bugs.exim.org/show_bug.cgi?id=2285

            Bug ID: 2285
           Summary: Document tolerance for null pointers in specific
                    function parameters
           Product: PCRE
           Version: 10.31 (PCRE2)
          Hardware: All
                OS: All
            Status: NEW
          Severity: wishlist
          Priority: medium
         Component: Documentation
          Assignee: ph10@???
          Reporter: elfring@???
                CC: pcre-dev@???

Some functions are implemented in the way that they check if a null pointer was
passed as an input parameter.
These functions return then immediately.

Examples:
* pcre2_code_free()

https://vcs.pcre.org/pcre2/code/trunk/src/pcre2_compile.c?revision=941&view=markup#l1172

https://github.com/svn2github/pcre2/blob/1a3e26153fd67e23f8c0c4e053504c2bae1d6547/src/pcre2_compile.c#L1172

* pcre2_match_data_free()

https://vcs.pcre.org/pcre2/code/trunk/src/pcre2_match_data.c?revision=780&view=markup#l89

https://github.com/svn2github/pcre2/blob/89c86560874a8cfa422be7d2b22d18ed6e20635e/src/pcre2_match_data.c#L89


Can such a detail become an official property in the affected application
programming interface?
How would you like to represent information about existing input parameter
validation in the corresponding API documentation?

Update candidates:
*
https://vcs.pcre.org/pcre2/code/trunk/doc/pcre2_code_free.3?revision=842&view=markup

https://github.com/svn2github/pcre2/blob/f3d7f4fabd6d124ad8e323b09ebf373bfe045b4e/doc/pcre2_code_free.3

*
https://vcs.pcre.org/pcre2/code/trunk/doc/pcre2_match_data_free.3?revision=709&view=markup

https://github.com/svn2github/pcre2/blob/55f5d081c04b7c8e6b5867ccfad3c731a2cc6870/doc/pcre2_match_data_free.3

--
You are receiving this mail because:
You are on the CC list for the bug.