Update documents.

Author: ChenPi11

doc/architectures.md

@@ -1,14 +1,23 @@
 # Architectures
+
 ## Source
-src/architectures.h
-## Content
+
+[src/architectures.h](https://github.com/cppp-project/cppp-platform/blob/main/src/architectures.h)
+
+## Contents
+
 ### \_\_arch\_\_
-#### Type
-macros
-#### Description
-Represents the processor architecture type
-If the judgment fails, the value is '\_\_arch_unknown\_\_'
-#### We provide preset architecture macros
+
+#### The type of \_\_arch\_\_
+
+macro
+
+#### Description of \_\_arch\_\_
+
+Represents the processor architecture type. If the judgment fails, the value is set to '\_\_arch_unknown\_\_'.
+
+#### Value of \_\_arch\_\_
+
 | Architecture | Macro |
 | :----: | :----: |
 | Alpha | \_\_arch_alpha\_\_ |
@@ -31,40 +40,60 @@ If the judgment fails, the value is '\_\_arch_unknown\_\_'
 | TMS470 | \_\_arch_tms470\_\_8 |
 | Unknown architecture | \_\_arch_unknown\_\_ |
 
-#### Usage
+#### Example of \_\_arch\_\_
+
 ```c
 #include <cppp/cppp-platform.h>
+
 #if (__arch__ == __arch_x86__)
-#pragma message "Build in x86 arch"
+#pragma message "Build in x86."
 #elif (__arch__ == __arch_arm__)
-#pragma message "Build in arm arch"
+#pragma message "Build in arm."
 #elif
-#pragma message "Build in other arch"
+#pragma message "Build in other."
 #endif
-int main(){}
+
+int main()
+{
+    return 0;
+}
 ```
+
 ### \_\_arch_name\_\_
-#### Type
+
+#### Type of \_\_arch_name\_\_
+
 macro
-#### Description
-Architecture name, like 'uname -m'
-If the judgment fails, the value is "unknown"
-#### Usage
+
+#### Description of \_\_arch_name\_\_
+
+Architecture name, like `uname -m`. If the judgment fails, the value is `"Unknown"`.
+
+#### Example of \_\_arch_name\_\_
+
 ```c
 #include <cppp/cppp-platform.h>
+
 #include <stdio.h>
+
 int main()
 {
     printf("Arch name: %s\n", __arch_name__);
 }
 ```
+
 ### \_\_POINTER_WIDTH\_\_
-#### Type
+
+#### Type of \_\_POINTER_WIDTH\_\_
+
 macro
-#### Description
-This represents the calculation formula for pointer length
-The value is generally 32 or 64
-#### Usage
+
+#### Description of \_\_POINTER_WIDTH\_\_
+
+This represents the pointer length. The value is generally 32 or 64.
+
+#### Example of \_\_POINTER_WIDTH\_\_
+
 ```c
 #include <cppp/cppp-platform.h>
 #include <stdio.h>

doc/compilers.md

@@ -1,24 +1,27 @@
 # Compilers
+
 ## Source
-src/compilers.h
+
+[src/compilers.h](https://github.com/cppp-project/cppp-platform/blob/main/src/compilers.h)
+
 ## Content
+
 ### \_\_has_xxx_compiler\_\_
-#### Type
-macros
-#### Description
-1 if there is a corresponding compiler, otherwise 0.
-The 'xxx' here refers to the compiler name, and details can be found in the 'src/compilers.h' source code.
-
-**Note: An environment may contain multiple compiler environments.**
-#### Usage
-```c
-#include <cppp/cppp-platform.h>
-#if __has_msvc_compiler__
-#error "This project do not support MSVC!"
-#endif
-int main(){}
-```
-#### We provide preset compiler macros
+
+#### Type of \_\_has_xxx_compiler\_\_
+
+macro
+
+#### Description of \_\_has_xxx_compiler\_\_
+
+`1` if there is a corresponding compiler, otherwise `0`.
+
+The 'xxx' here refers to the compiler name, and details can be found in the `src/compilers.h` source code.
+
+**Note: An environment may contain multiple compiler environments, so multiple compiler macros may be defined at the same time. e.g. `__has_gcc_compiler__`, `__has_clang_compiler__`.**
+
+#### Compiler List
+
 | Compiler | Macro |
 | :----: | :----: |
 | ACC | \_\_has_acc_compiler\_\_ |
@@ -92,3 +95,18 @@ int main(){}
 | VBCC | \_\_has_vbcc_compiler\_\_ |
 | Watcom C++ | \_\_has_watcom_compiler\_\_ |
 | Zortech C++ | \_\_has_zortech_compiler\_\_ |
+
+#### Example of \_\_has_xxx_compiler\_\_
+
+```c
+#include <cppp/cppp-platform.h>
+
+#if __has_msvc_compiler__
+#error "This project do not support MSVC!"
+#endif
+
+int main()
+{
+    return 0;
+}
+```

doc/doc.md

@@ -1,4 +1,5 @@
-# cppp-platform Manual
+# cppp-platform Documentation
+
 [Architectures](./architectures.md)
 
 [Compilers](./compilers.md)

doc/languagestandards.md

@@ -1,44 +1,81 @@
 # C/C++ Standards
+
 ## Source
-src/languagestandards.h
+
+[src/languagestandards.h](https://github.com/cppp-project/cppp-platform/blob/main/src/languagestandards.h)
+
 ## Content
-## \_\_has_cXX\_\_
-#### Type
-macros
-#### Description
+
+### \_\_has_cXX\_\_
+
+#### Type of \_\_has_cXX\_\_
+
+macro
+
+#### Description of \_\_has_cXX\_\_
+
 The 'XX' here refers to the C standard, and details can be found in the 'src/languagestandards.h' source code.
+
 #### Usage
+
 ```c
 #include <cppp/cppp-platform.h>
+
 #if __has_c11__
 #pragma message "You are in C11."
 #endif
-int main(){}
+
+int main()
+{
+    return 0;
+}
 ```
-## \_\_has_cppXX\_\_
-#### Type
-macros
-#### Description
-The 'XX' here refers to the C++ standard, and details can be found in the 'src/languagestandards.h' source code.
-#### Usage
+
+### \_\_has_cppXX\_\_
+
+#### Type of \_\_has_cppXX\_\_
+
+macro
+
+#### Description of \_\_has_cppXX\_\_
+
+The 'XX' here refers to the C++ standard, and details can be found in the `src/languagestandards.h` source code.
+
+#### Usage of \_\_has_cppXX\_\_
+
 ```c
 #include <cppp/cppp-platform.h>
+
 #if __has_cpp17__
 #pragma message "You are in C++17."
 #endif
-int main(){}
+
+int main()
+{
+    return 0;
+}
 ```
-## \_\_cpp_version\_\_
-#### Type
+
+### \_\_cpp_version\_\_
+
+#### Type of \_\_cpp_version\_\_
+
 macro
-#### Description
+
+#### Description of \_\_cpp_version\_\_
+
 C++ standard for fixing issues with '\_MSVC_LANG'
-### Usage
+
+### Usage of \_\_cpp_version\_\_
+
 ```cpp
 #include <cppp/cppp-platform.h>
+
 #include <iostream>
+
 int main()
 {
-    std::cout<<__cpp_version__<<"\n";
+    std::cout << __cpp_version__ << std::endl;
+    return EXIT_SUCCESS;
 }
 ```

doc/platforms.md

@@ -1,24 +1,27 @@
 # Platforms
+
 ## Source
-src/platforms.h
+
+[src/platforms.h](https://github.com/cppp-project/cppp-platform/blob/main/src/platforms.h)
+
 ## Content
-## \_\_has_xxx\_\_
-#### Type
-macros
-#### Description
-If there is a corresponding OS environment, it is 1, otherwise it is 0.
-The 'xxx' here refers to the OS name, and details can be found in the 'src/platforms.h' source code.
-
-**Note: An compile environment may contain multiple environments**
-#### Usage
-```c
-#include <cppp/cppp-platform.h>
-#if __has_windows__
-#error "We do not support Windows!"
-#endif
-int main(){}
-```
+
+### \_\_has_xxx\_\_
+
+#### Type of \_\_has_xxx\_\_
+
+macro
+
+#### Description of \_\_has_xxx\_\_
+
+If there is a corresponding OS environment, it is `1`, otherwise it is `0`.
+
+The 'xxx' here refers to the OS name, and details can be found in the `src/platforms.h` source code.
+
+**Note: An compile environment may contain multiple environments at the same time. e.g. Cygwin Environment is a Unix-like environment, but it is also a Windows environment.**
+
 #### We provide preset compiler macros
+
 | Platform | Macro |
 | :----: | :----: |
 | AIX | \_\_has_aix\_\_ |
@@ -51,7 +54,7 @@ int main(){}
 | MinGW | \_\_has_mingw\_\_ |
 | MorphOS | \_\_has_morph_os\_\_ |
 | MPE/iX | \_\_has_mpe_ix\_\_ |
-| MSDOS (C++ Plus C unsupport platform) | \_\_has_dos\_\_ |
+| MSDOS | \_\_has_dos\_\_ |
 | NonStop | \_\_has_non_stop\_\_ |
 | Nucleus RTOS | \_\_has_nucleus\_\_ |
 | OS/2 | \_\_has_os2\_\_ |
@@ -80,3 +83,18 @@ int main(){}
 | Windows CE | \_\_has_windows_ce\_\_ |
 | Wind/U Environment | \_\_has_windu\_\_ |
 | z/OS | \_\_has_zos\_\_ |
+
+#### Example of \_\_has_xxx\_\_
+
+```c
+#include <cppp/cppp-platform.h>
+
+#if __has_windows__
+#error "We do not support Windows!"
+#endif
+
+int main()
+{
+    return 0;
+}
+```