From 4ea43dc01e53643bbda920b57e66ace41b03874a Mon Sep 17 00:00:00 2001
From: Mohammed Ghannam <mohammad.m.ghannam@gmail.com>
Date: Fri, 15 Nov 2024 08:16:24 +0100
Subject: [PATCH] Add sentence about capitalized typedefs (from Stefan)

---
 doc/xternal.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/xternal.c b/doc/xternal.c
index 9b8a4fdedd..665e4954b1 100644
--- a/doc/xternal.c
+++ b/doc/xternal.c
@@ -7863,7 +7863,9 @@
  *    These functions should follow the naming style `SCIP<operation><component>...`, e.g., <code>SCIPcreateVar()</code> or <code>SCIPaddVarLocks</code>.
  *  - To ensure functions of the public API being reachable in shared libraries, their declaration needs to contain the <code>SCIP_EXPORT</code> attribute.
  *  - Public types (typedef's, enumerations) are defined in file <code>type_<component>.h</code>.
- *    Type names follow the style <code>SCIP_<COMPONENT>...</code>.
+ *    Type names follow the style <code>SCIP_<COMPONENT>...</code>. For every struct, we have a typedef that shortens the name 
+ *    (so one could for instance use <code>SCIP_PARAM</code> instead of <code>struct SCIP_Param</code>).
+ *    The convention is to have the mixed-casing for the struct name, and then all-capital for the typedef's type. Similar for enums.
  *  - Structs that need to be accessed by several source files are defined in <code>struct_<component>.h</code>.
  *    <code>struct_<component>.h</code> is usually included only by <code><component>.c</code> and maybe <code>scip_<component>.c</code>.
  *    Exceptions are due to manual inlining of functions via macros when compiling for optimized mode.