plan-be / plan-be/iode

C API: Document structures in iode.h

Open
#342 0 comments 0 reactions 1 assignee View on GitHub

@jmpplan is already working on this.

Since Sep 8, 2023.

C API documentation priority: high
Dominant language
C++
Stars
2
Forks
1
Avg merge
7h 35m
Merged PRs (30d)
13

Description

Some structures declared in iode.h are still not documented.

For instance, many elements of the KDB struct are not explained (k_mode ?, k_arch ?, k_magic ?, ...).
Some elements of CLEC struct are not explained: tot_lg vs exec_lg ?, dupendo ?

Please try to better document the internal elements of the structures in iode.h.
Please note when elements of some structures are no longer used.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.