Documentation: Flatten the Browser/ directory

Separating out the browser documentation doesn't make much sense now
that we are only a browser. :^)
This commit is contained in:
Sam Atkins 2024-10-22 15:30:16 +01:00 committed by Andreas Kling
commit 86744449e3
Notes: github-actions[bot] 2024-10-23 07:03:42 +00:00
11 changed files with 12 additions and 13 deletions

View file

@ -23,10 +23,10 @@ interface CSSRule {
}; };
``` ```
3. Add a `libweb_js_bindings(HTML/HTMLDetailsElement)` call to [`LibWeb/idl_files.cmake`](../../Userland/Libraries/LibWeb/idl_files.cmake) 3. Add a `libweb_js_bindings(HTML/HTMLDetailsElement)` call to [`LibWeb/idl_files.cmake`](../Userland/Libraries/LibWeb/idl_files.cmake)
4. Forward declare the generated class in [`LibWeb/Forward.h`](../../Userland/Libraries/LibWeb/Forward.h): 4. Forward declare the generated class in [`LibWeb/Forward.h`](../Userland/Libraries/LibWeb/Forward.h):
- `HTMLDetailsElement` in its namespace. - `HTMLDetailsElement` in its namespace.
5. If your type isn't an Event or Element, you will need to add it to [`is_platform_object()`](../../Meta/Lagom/Tools/CodeGenerators/LibWeb/BindingsGenerator/IDLGenerators.cpp) 5. If your type isn't an Event or Element, you will need to add it to [`is_platform_object()`](../Meta/Lagom/Tools/CodeGenerators/LibWeb/BindingsGenerator/IDLGenerators.cpp)
so that it can be accepted as an IDL parameter, attribute or return type. so that it can be accepted as an IDL parameter, attribute or return type.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

View file

@ -1,11 +1,11 @@
# CSS Generated Files # CSS Generated Files
We generate a significant amount of CSS-related code, taking in one or more .json files in We generate a significant amount of CSS-related code, taking in one or more .json files in
[`Userland/Libraries/LibWeb/CSS`](../../Userland/Libraries/LibWeb/CSS) and producing C++ code from them, located in [`Userland/Libraries/LibWeb/CSS`](../Userland/Libraries/LibWeb/CSS) and producing C++ code from them, located in
`Build/<build-preset>/Lagom/Userland/Libraries/LibWeb/CSS/`. `Build/<build-preset>/Lagom/Userland/Libraries/LibWeb/CSS/`.
It's likely that you'll need to work with these if you add or modify a CSS property or its values. It's likely that you'll need to work with these if you add or modify a CSS property or its values.
The generators are found in [`Meta/Lagom/Tools/CodeGenerators/LibWeb`](../../Meta/Lagom/Tools/CodeGenerators/LibWeb). The generators are found in [`Meta/Lagom/Tools/CodeGenerators/LibWeb`](../Meta/Lagom/Tools/CodeGenerators/LibWeb).
They are run automatically as part of the build, and most of the time you can ignore them. They are run automatically as part of the build, and most of the time you can ignore them.
## Properties.json ## Properties.json

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View file

@ -6,7 +6,7 @@ The SerenityOS web browser (**"Browser"**) uses a multi-process architecture to
## Process overview ## Process overview
![](processes.png) ![](Images/processes.png)
Every instance of the **Browser** application can have one or more tabs open. Each tab has a unique **WebContent** service process spawned on its behalf. Every instance of the **Browser** application can have one or more tabs open. Each tab has a unique **WebContent** service process spawned on its behalf.
@ -39,7 +39,7 @@ by **WebContent** as needed, not by **Browser**.
## Class overview ## Class overview
![](classes.png) ![](Images/classes.png)
In the GUI application process, a `OutOfProcessWebView` widget is placed somewhere in a window, and it takes care of spawning all of the helper processes, etc. In the GUI application process, a `OutOfProcessWebView` widget is placed somewhere in a window, and it takes care of spawning all of the helper processes, etc.

View file

@ -31,10 +31,9 @@ you are welcome to ask on [Discord](../README.md#get-in-touch-and-participate).
* [String Formatting](StringFormatting.md) * [String Formatting](StringFormatting.md)
## Browser/LibWeb ## Browser/LibWeb
* [Ladybird Browser Build Instructions](BuildInstructionsLadybird.md) * [General Architecture](ProcessArchitecture.md)
* [General Architecture](Browser/ProcessArchitecture.md) * [LibWeb: From Loading to Painting](LibWebFromLoadingToPainting.md)
* [LibWeb: From Loading to Painting](Browser/LibWebFromLoadingToPainting.md) * [LibWeb: Browsing Contexts and Navigables](BrowsingContextsAndNavigables.md)
* [LibWeb: Browsing Contexts and Navigables](Browser/BrowsingContextsAndNavigables.md) * [How to Add an IDL File](AddNewIDLFile.md)
* [How to Add an IDL File](Browser/AddNewIDLFile.md)
* [LibWeb Code Style & Patterns](Browser/Patterns.md) * [LibWeb Code Style & Patterns](Browser/Patterns.md)
* [CSS Generated Files](Browser/CSSGeneratedFiles.md) * [CSS Generated Files](CSSGeneratedFiles.md)