Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
redox
redox
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 211
    • Issues 211
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 9
    • Merge Requests 9
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • redox-os
  • redoxredox
  • Issues
  • #610

Closed
Open
Opened Apr 09, 2016 by Jeremy Soller@jackpot51Owner20 of 174 tasks completed20/174 tasks

API documentation and manual pages (list)

Created by: ticki

  • API docs.
    • libextra
    • libmalloc
    • binutils
    • Sodium
    • OrbTK
    • Orbclient
    • Redox-specific std
    • System
      • Helper functions
      • Errors
      • Graphics
      • Scheme
        • Scheme
        • Packet
      • syscall
        • Constants
        • syscalls
          • sys_debug
          • sys_supervise
          • sys_brk
          • sys_chdir
          • sys_clock_gettime
          • sys_clone
          • sys_close
          • sys_dup
          • sys_execve
          • sys_exit
          • sys_fpath
          • sys_fstat
          • sys_fsync
          • sys_ftruncate
          • sys_getpid
          • sys_iopl
          • sys_link
          • sys_lseek
          • sys_mkdir
          • sys_nanosleep
          • sys_open
          • sys_pipe2
          • sys_read
          • sys_rmdir
          • sys_stat
          • sys_unlink
          • sys_waitpid
          • sys_write
          • sys_yield
    • Kernel
      • Top-level modules.
      • Top-level constants.
      • Top-level functions.
      • ACPI
      • Alloc
      • Arch
        • context
          • ContextManager
          • Context
          • ContextMemory
          • ContextFile
          • EnvironmentVariable
          • ContextZone
          • context_switch
          • context_clone
          • context_box
          • context_userspace
          • Constants
        • elf
        • Intex et al.
        • memory
          • Memory
          • MemoryMapEntry
          • address_to_cluster
          • alloc
          • alloc_aligned
          • alloc_size
          • alloc_type
          • cluster
          • cluster_init
          • cluster_to_address
          • memory_free
          • memory_used
          • realloc
          • realloc_aligned
          • realloc_inplace
          • set_cluster
          • unalloc
          • unalloc_type
        • paging
        • regs
        • tss
      • audio
        • ac97
        • intelhda
      • common
        • debug
        • event
        • parse_ip
        • parse_path
        • random
        • slice
        • time
        • to_num
      • disk
        • ahci
        • ide
        • Disk
      • drivers
        • kb_layouts
        • pci
        • ps2
        • rtc
        • serial
      • env
      • externs
      • fs
        • redoxfs
        • kscheme
        • VecResource
        • scheme
        • URL
      • graphics
        • color
        • display
      • macros
      • network
        • common
        • ethernet
        • intel8254x
        • ipv4
        • ipv6
        • rtl8139
        • scheme
        • schemes
      • panic
      • scheme
        • context
        • debug
        • display
        • env
        • file
        • initfs
        • interrupt
        • memory
        • pipe
        • test
      • sync
        • wait_condition
        • wait_map
        • wait_queue
      • syscall
        • debug
        • execute
        • file
        • memory
        • process
        • time
      • usb
        • desc
        • ehci
        • hci
        • ohci
        • setup
        • uhci
        • xhci
  • Mapages
    • coreutils
    • syscalls
    • extrautils
    • binutils
    • Orbital
    • Sodium
    • Ion
    • RedoxFS
    • Various handy manpages (e.g. ASCII, possibly sheets).

We suck at API docs. Preferably every entry should have a detailed description of the functionality. Currently, most only have a short trivial description, despite not having a trivial functionality.

Assignee
Assign to
Documentation
Milestone
Documentation
Assign milestone
Time tracking
None
Due date
None
Reference: redox-os/redox#610