doc/imgstore-signals.dox

Tue, 21 Jan 2025 10:44:24 -0600

author
Elliott Sales de Andrade <quantum.analyst@gmail.com>
date
Tue, 21 Jan 2025 10:44:24 -0600
branch
release-2.x.y
changeset 43153
2e4624a59df5
parent 20897
2608e9e07913
permissions
-rw-r--r--

zephyr: Modernize K&R function prototypes

This is a backport of 811f82db29dd, as GCC and/or Clang is warning how these are outdated and unsupported for C23.

Testing Done:
Compiled with GCC 15 without `-Wold-style-prototype` warnings raised.

Reviewed at https://reviews.imfreedom.org/r/3775/

/** @page imgstore-signals Image Store Signals

 @signals
  @signal image-deleting
 @endsignals

 @see imgstore.h

 <hr>

 @signaldef image-deleting
  @signalproto
char *(*image_deleting)(const PurpleStoredImage *img);
  @endsignalproto
  @signaldesc
   Emitted when a #PurpleStoredImage is about to be destroyed.  This allows
   for what amounts to weak references.  Code can hold onto a pointer to
   the PurpleStoredImage without actually "holding" a reference.  They can
   then use a signal handler to let them know when their img is about to
   be destroyed.
  @param img The image about to be destroyed.
  @note It's not possible to purple_imgstore_ref() img to save it.
 @endsignaldef

*/
// vim: syntax=c.doxygen tw=75 et

mercurial