git.y1.nz

commit 80757a789e357882d0d3367319f3e4cb468d3d70
parent 6e02cc37f8dcd2eea2b66d841671606735cca8fb
Author: bbbbbr <bbbbbr@users.noreply.github.com>
Date:   Tue,  1 Feb 2022 00:18:56 -0800

Merge pull request #310 from bbbbbr/docs_4_0_6

Updates for 4.0.6
Diffstat:
M
Makefile
6
+++---
M
docs/config/gbdk-2020-doxyfile
2
+-
M
docs/pages/01_getting_started.md
2
+-
M
docs/pages/10_release_notes.md
3
+++
M
gbdk-lib/include/asm/gbz80/string.h
24
+++++++++++++++---------

5 files changed, 23 insertions(+), 14 deletions(-)
diff --git a/Makefile b/Makefile
@@ -7,8 +7,8 @@ TOPDIR = $(shell pwd)
 
 # Package name, used for tarballs
 PKG = gbdk
-# Version, used for tarballs
-VER = 3.00
+# Version, used for tarballs & docs
+VER = 4.0.6
 
 PORTS=gbz80 z80
 PLATFORMS=gb ap duck gg sms
@@ -298,7 +298,7 @@ endif
 #Run Doxygen	
 	rm -rf $(GBDKDOCSDIR)/api; \
 	  cd "$(GBDKLIBDIR)/include"; \
-	  GBDKDOCSDIR="$(GBDKDOCSDIR)" GBDKLIBDIR="$(GBDKLIBDIR)" $(DOXYGENCMD) "$(GBDKDOCSDIR)/config/gbdk-2020-doxyfile"
+	  GBDKDOCSDIR="$(GBDKDOCSDIR)" GBDKVERSION=$(VER) GBDKLIBDIR="$(GBDKLIBDIR)" $(DOXYGENCMD) "$(GBDKDOCSDIR)/config/gbdk-2020-doxyfile"
 	@if [ "$(DOCS_PDF_ON)" = "YES" ]; then\
 		$(MAKE) -C $(GBDKDOCSDIR)/latex;\
 		cp $(GBDKDOCSDIR)/latex/refman.pdf $(GBDKDOCSDIR)/gbdk_manual.pdf;\
diff --git a/docs/config/gbdk-2020-doxyfile b/docs/config/gbdk-2020-doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "GBDK 2020 Docs"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = $(GBDKVERSION)
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
diff --git a/docs/pages/01_getting_started.md b/docs/pages/01_getting_started.md
@@ -100,7 +100,7 @@ Check out the links for @ref links_help_and_community "online community and supp
 
 
 # Migrating From Pre-GBDK-2020 Tutorials
-Several popular GBDK Tutorials, Videos and How-to's were made before GBDK-2020 was available. As a result some information they include is outdated or incompatible. The following summarizes changes that should be made for best results.
+Several popular GBDK Tutorials, Videos and How-to's were made before GBDK-2020 was available, as a result some information they include is outdated or incompatible. The following summarizes changes that should be made for best results.
 
 ## Also see: 
 - @ref docs_migrating_versions
diff --git a/docs/pages/10_release_notes.md b/docs/pages/10_release_notes.md
@@ -52,6 +52,9 @@ https://github.com/gbdk-2020/gbdk-2020/releases
     - Changed use of set_interrupts() in examples so it's outside critical sections (since it disables/enables interrupts)
     - Changed cross-platform auto-banks example to use .h header files
     - Changed SGB border example to also work with SGB on PAL SNES
+  - Docs
+    - Added new section: Migrating From Pre-GBDK-2020 Tutorials
+
 
 ## GBDK 2020 4.0.5
   2021/09
diff --git a/gbdk-lib/include/asm/gbz80/string.h b/gbdk-lib/include/asm/gbz80/string.h
@@ -98,16 +98,19 @@ int strlen(const char *s) OLDCALL PRESERVES_REGS(b, c);
 */
 char *strncat(char *s1, const char *s2, int n);
 
-/** Compare strings (at most n characters):
+/** Compare strings (at most __n__ characters):
 
     @param s1         First string to compare
     @param s2         Second string to compare
     @param n          Max number of characters to compare
 
+    Returns zero if the strings are identical, or non-zero
+    if they are not (see below).
+
     Returns:
-    \li > 0 if __s1__ > __s2__
+    \li > 0 if __s1__ > __s2__ (at first non-matching byte)
     \li 0 if __s1__ == __s2__
-    \li < 0 if __s1__ < __s2__
+    \li < 0 if __s1__ < __s2__ (at first non-matching byte)
 */
 int strncmp(const char *s1, const char *s2, int n);
 
@@ -128,16 +131,19 @@ int strncmp(const char *s1, const char *s2, int n);
 */
 char *strncpy(char *s1, const char *s2, int n);
 
-/** Compares buffers
+/** Compare up to __count__ bytes in buffers __buf1__ and __buf2__
+
+    @param buf1         Pointer to First buffer to compare
+    @param buf2         Pointer to Second buffer to compare
+    @param count        Max number of bytes to compare
 
-    @param buf1         First buffer to compare
-    @param buf2         Second buffer to compare
-    @param count        Buffer length
+    Returns zero if the buffers are identical, or non-zero
+    if they are not (see below).
 
     Returns:
-    \li > 0 if __buf1__ > __buf2__
+    \li > 0 if __buf1__ > __buf2__ (at first non-matching byte)
     \li 0 if __buf1__ == __buf2__
-    \li < 0 if __buf1__ < __buf2__
+    \li < 0 if __buf1__ < __buf2__ (at first non-matching byte)
 */
 int memcmp(const void *buf1, const void *buf2, size_t count) OLDCALL;
 

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.