Improve documentation

The Cosmo API documentation page is pretty good now
https://justine.lol/cosmopolitan/documentation.html
This commit is contained in:
Justine Tunney
2020-12-27 07:02:35 -08:00
parent 13437dd19b
commit 1bc3a25505
367 changed files with 2542 additions and 26178 deletions

View File

@@ -20,7 +20,7 @@
#include "libc/str/str.h"
/**
* Returns nonzero if c ∈ !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
* Returns nonzero if ``c ∈ !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~``
*/
int ispunct(int c) {
return (0x21 <= c && c <= 0x7E) && !('0' <= c && c <= '9') &&

View File

@@ -1,33 +0,0 @@
/*-*- mode:c;indent-tabs-mode:nil;c-basic-offset:2;tab-width:8;coding:utf-8 -*-│
│vi: set net ft=c ts=2 sts=2 sw=2 fenc=utf-8 :vi│
╞══════════════════════════════════════════════════════════════════════════════╡
│ Copyright 2020 Justine Alexandra Roberts Tunney │
│ │
│ This program is free software; you can redistribute it and/or modify │
│ it under the terms of the GNU General Public License as published by │
│ the Free Software Foundation; version 2 of the License. │
│ │
│ This program is distributed in the hope that it will be useful, but │
│ WITHOUT ANY WARRANTY; without even the implied warranty of │
│ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU │
│ General Public License for more details. │
│ │
│ You should have received a copy of the GNU General Public License │
│ along with this program; if not, write to the Free Software │
│ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA │
│ 02110-1301 USA │
╚─────────────────────────────────────────────────────────────────────────────*/
#include "tool/viz/lib/knobs.h"
bool pf1_;
bool pf2_;
bool pf3_;
bool pf4_;
bool pf5_;
bool pf6_;
bool pf7_;
bool pf8_;
bool pf9_;
bool pf10_;
bool pf11_;
bool pf12_;

View File

@@ -21,7 +21,7 @@
#include "libc/macros.h"
#include "libc/nexgen32e/x86info.h"
const struct X86ProcessorModel kX86ProcessorModels[] = {
hidden const struct X86ProcessorModel kX86ProcessorModels[] = {
/* <SORTED> */
{0x060F, X86_MARCH_CORE2, X86_GRADE_CLIENT},
{0x0616, X86_MARCH_CORE2, X86_GRADE_MOBILE},
@@ -80,4 +80,4 @@ const struct X86ProcessorModel kX86ProcessorModels[] = {
/* </SORTED> */
};
const size_t kX86ProcessorModelCount = ARRAYLEN(kX86ProcessorModels);
hidden const size_t kX86ProcessorModelCount = ARRAYLEN(kX86ProcessorModels);

View File

@@ -11,7 +11,7 @@
* http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf
This implementation uses little endian byte order.
*********************************************************************/
#include "libc/bits/safemacros.internal.h"
#include "libc/bits/safemacros.h"
#include "libc/dce.h"
#include "libc/nexgen32e/x86feature.h"
#include "libc/str/internal.h"

View File

@@ -17,7 +17,7 @@
│ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA │
│ 02110-1301 USA │
╚─────────────────────────────────────────────────────────────────────────────*/
#include "libc/bits/safemacros.internal.h"
#include "libc/bits/safemacros.h"
#include "libc/str/str.h"
/**

View File

@@ -17,7 +17,7 @@
│ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA │
│ 02110-1301 USA │
╚─────────────────────────────────────────────────────────────────────────────*/
#include "libc/bits/safemacros.internal.h"
#include "libc/bits/safemacros.h"
#include "libc/macros.h"
#include "libc/str/str.h"

View File

@@ -33,6 +33,7 @@ forceinline int getbyte(void *arg, uint32_t i) {
* @return number of bytes successfully consumed or -1 w/ errno
* @note synchronization is performed
* @see libc/str/tpdecodecb.internal.h (for implementation)
* @deprecated
*/
int(tpdecode)(const char *s, wint_t *out) {
return tpdecodecb(out, (unsigned char)s[0], getbyte, (void *)s);

View File

@@ -36,6 +36,7 @@
* @param awesome mode enables numbers the IETF unilaterally banned
* @return number of bytes written
* @note this encoding was designed on a napkin in a new jersey diner
* @deprecated
*/
unsigned(tpencode)(char *p, size_t size, wint_t wc, bool32 awesome) {
int i, j;