[libng16] Mention prototype format in the documentation (libpng style guide)

This commit is contained in:
Glenn Randers-Pehrson 2014-03-05 17:14:16 -06:00
parent 24afd07ab9
commit c978642c48
3 changed files with 21 additions and 16 deletions

View File

@ -1,6 +1,6 @@
libpng-manual.txt - A description on how to use and modify libpng libpng-manual.txt - A description on how to use and modify libpng
libpng version 1.6.10rc04 - March 4, 2014 libpng version 1.6.10rc04 - March 5, 2014
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
<glennrp at users.sourceforge.net> <glennrp at users.sourceforge.net>
Copyright (c) 1998-2014 Glenn Randers-Pehrson Copyright (c) 1998-2014 Glenn Randers-Pehrson
@ -11,7 +11,7 @@ libpng-manual.txt - A description on how to use and modify libpng
Based on: Based on:
libpng versions 0.97, January 1998, through 1.6.10rc04 - March 4, 2014 libpng versions 0.97, January 1998, through 1.6.10rc04 - March 5, 2014
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
Copyright (c) 1998-2014 Glenn Randers-Pehrson Copyright (c) 1998-2014 Glenn Randers-Pehrson
@ -5337,8 +5337,8 @@ We don't use C++ style ("//") comments. We have, however,
used them in the past in some now-abandoned MMX assembler used them in the past in some now-abandoned MMX assembler
code. code.
Functions and their curly braces are not indented, and Functions and their curly braces are not indented, exported
exported functions are marked with PNGAPI: functions are marked with PNGAPI:
/* This is a public function that is visible to /* This is a public function that is visible to
* application programmers. It does thus-and-so. * application programmers. It does thus-and-so.
@ -5349,6 +5349,9 @@ exported functions are marked with PNGAPI:
body; body;
} }
The return type and decorations are placed on a separate line
ahead of the function name, as illustrated above.
The prototypes for all exported functions appear in png.h, The prototypes for all exported functions appear in png.h,
above the comment that says above the comment that says
@ -5413,7 +5416,7 @@ Other rules can be inferred by inspecting the libpng source.
XVI. Y2K Compliance in libpng XVI. Y2K Compliance in libpng
March 4, 2014 March 5, 2014
Since the PNG Development group is an ad-hoc body, we can't make Since the PNG Development group is an ad-hoc body, we can't make
an official declaration. an official declaration.

View File

@ -1,4 +1,4 @@
.TH LIBPNG 3 "March 4, 2014" .TH LIBPNG 3 "March 5, 2014"
.SH NAME .SH NAME
libpng \- Portable Network Graphics (PNG) Reference Library 1.6.10rc04 libpng \- Portable Network Graphics (PNG) Reference Library 1.6.10rc04
.SH SYNOPSIS .SH SYNOPSIS
@ -504,7 +504,7 @@ Following is a copy of the libpng-manual.txt file that accompanies libpng.
.SH LIBPNG.TXT .SH LIBPNG.TXT
libpng-manual.txt - A description on how to use and modify libpng libpng-manual.txt - A description on how to use and modify libpng
libpng version 1.6.10rc04 - March 4, 2014 libpng version 1.6.10rc04 - March 5, 2014
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
<glennrp at users.sourceforge.net> <glennrp at users.sourceforge.net>
Copyright (c) 1998-2014 Glenn Randers-Pehrson Copyright (c) 1998-2014 Glenn Randers-Pehrson
@ -515,7 +515,7 @@ libpng-manual.txt - A description on how to use and modify libpng
Based on: Based on:
libpng versions 0.97, January 1998, through 1.6.10rc04 - March 4, 2014 libpng versions 0.97, January 1998, through 1.6.10rc04 - March 5, 2014
Updated and distributed by Glenn Randers-Pehrson Updated and distributed by Glenn Randers-Pehrson
Copyright (c) 1998-2014 Glenn Randers-Pehrson Copyright (c) 1998-2014 Glenn Randers-Pehrson
@ -5842,8 +5842,8 @@ We don't use C++ style ("//") comments. We have, however,
used them in the past in some now-abandoned MMX assembler used them in the past in some now-abandoned MMX assembler
code. code.
Functions and their curly braces are not indented, and Functions and their curly braces are not indented, exported
exported functions are marked with PNGAPI: functions are marked with PNGAPI:
/* This is a public function that is visible to /* This is a public function that is visible to
* application programmers. It does thus-and-so. * application programmers. It does thus-and-so.
@ -5854,6 +5854,9 @@ exported functions are marked with PNGAPI:
body; body;
} }
The return type and decorations are placed on a separate line
ahead of the function name, as illustrated above.
The prototypes for all exported functions appear in png.h, The prototypes for all exported functions appear in png.h,
above the comment that says above the comment that says
@ -5918,7 +5921,7 @@ Other rules can be inferred by inspecting the libpng source.
.SH XVI. Y2K Compliance in libpng .SH XVI. Y2K Compliance in libpng
March 4, 2014 March 5, 2014
Since the PNG Development group is an ad-hoc body, we can't make Since the PNG Development group is an ad-hoc body, we can't make
an official declaration. an official declaration.
@ -6213,7 +6216,7 @@ possible without all of you.
Thanks to Frank J. T. Wojcik for helping with the documentation. Thanks to Frank J. T. Wojcik for helping with the documentation.
Libpng version 1.6.10rc04 - March 4, 2014: Libpng version 1.6.10rc04 - March 5, 2014:
Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc. Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc.
Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net). Currently maintained by Glenn Randers-Pehrson (glennrp at users.sourceforge.net).
@ -6236,7 +6239,7 @@ this sentence.
This code is released under the libpng license. This code is released under the libpng license.
libpng versions 1.2.6, August 15, 2004, through 1.6.10rc04, March 4, 2014, are libpng versions 1.2.6, August 15, 2004, through 1.6.10rc04, March 5, 2014, are
Copyright (c) 2004,2006-2007 Glenn Randers-Pehrson, and are Copyright (c) 2004,2006-2007 Glenn Randers-Pehrson, and are
distributed according to the same disclaimer and license as libpng-1.2.5 distributed according to the same disclaimer and license as libpng-1.2.5
with the following individual added to the list of Contributing Authors with the following individual added to the list of Contributing Authors
@ -6335,7 +6338,7 @@ certification mark of the Open Source Initiative.
Glenn Randers-Pehrson Glenn Randers-Pehrson
glennrp at users.sourceforge.net glennrp at users.sourceforge.net
March 4, 2014 March 5, 2014
.\" end of man page .\" end of man page

View File

@ -668,8 +668,7 @@ set_location(png_structp png_ptr, struct user_chunk_data *data, int what)
} }
static int PNGCBAPI static int PNGCBAPI
read_user_chunk_callback(png_struct *png_ptr, read_user_chunk_callback(png_struct *png_ptr, png_unknown_chunkp chunk)
png_unknown_chunkp chunk)
{ {
struct user_chunk_data *my_user_chunk_data = struct user_chunk_data *my_user_chunk_data =
(struct user_chunk_data*)png_get_user_chunk_ptr(png_ptr); (struct user_chunk_data*)png_get_user_chunk_ptr(png_ptr);