diff --git a/com.unity.mobile.android-logcat/Documentation~/android-logcat-settings.md b/com.unity.mobile.android-logcat/Documentation~/android-logcat-settings.md index 6342ffb..aeb20b2 100644 --- a/com.unity.mobile.android-logcat/Documentation~/android-logcat-settings.md +++ b/com.unity.mobile.android-logcat/Documentation~/android-logcat-settings.md @@ -16,7 +16,7 @@ Use the **Reset** button at the bottom of the Settings window to restore the def Use **Messages** section to customize the appearance and the number of the messages displayed on the Android Logcat window. -![](images/logcat-settings-messages.png) +![Messages section on Android Logcat Settings window](images/logcat-settings-messages.png) |**Setting**|**Description**| @@ -28,7 +28,7 @@ Use **Messages** section to customize the appearance and the number of the messa ## Message Colors -![](images/logcat-settings-message-colors.png) +![Message colors customization](images/logcat-settings-message-colors.png) Use **Message Colors** setting to customize the color of the log messages displayed in the Android Logcat window. Customizing the colors can help you differentiate between different types of log messages, making it easier for you to identify any issues. You can assign different colors to log messages based on their priorities, such as **Verbose**, **Debug**, **Info**, **Warn**, **Error**, and **Fatal**. For more information about the priority levels, refer to Android documentation on [Filtering log output](https://developer.android.com/tools/logcat#filteringOutput). @@ -37,20 +37,20 @@ To customize the log message color, click anywhere on the swatch displayed next ## Memory Window -![](images/logcat-settings-memory-window.png) +![Memory Window](images/logcat-settings-memory-window.png) Use the **Request Interval ms** setting to specify a time interval to request memory information for the selected application on the connected device. The minimum time interval that you can specify is 500ms. ## Packages -![](images/logcat-settings-packages.png) +![Max Exited Packages](images/logcat-settings-packages.png) Use the **Max Exited Packages** setting to specify the maximum number for the applications selected in the Package Selector that are now closed. This allows you to restrict the number of entries in the Package Selector dropdown for closed applications to prevent overpopulating the dropdown. ## Stacktrace Regex -![](images/logcat-settings-stacktrace-regex.png) +![Stacktrace Regex](images/logcat-settings-stacktrace-regex.png) Use the **Stacktrace Regex** setting to configure regular expressions used for resolving function address and library names. You can add new regular expressions, remove, or disable the existing ones. @@ -62,7 +62,7 @@ For more information, refer to [configure stacktrace regular expressions](stackt ## Symbol Extensions -![](images/logcat-settings-symbol-extensions.png) +![Symbol Extensions](images/logcat-settings-symbol-extensions.png) Use the **Symbol Extensions** setting to specify file extensions which are appended to symbol file names during stacktrace resolving. diff --git a/com.unity.mobile.android-logcat/Documentation~/android-logcat-window-reference.md b/com.unity.mobile.android-logcat/Documentation~/android-logcat-window-reference.md index 2a4051d..307708f 100644 --- a/com.unity.mobile.android-logcat/Documentation~/android-logcat-window-reference.md +++ b/com.unity.mobile.android-logcat/Documentation~/android-logcat-window-reference.md @@ -2,19 +2,19 @@ This page introduces the different parts of the Android Logcat window's interface. -![](images/android-logcat-window.png) +![The Android Logcat window with toolbar and message log](images/android-logcat-window.png) > The Anrdoid Logcat window. | **Label** | **Description** | | ----------------------- | ------------------------------------------------------------ | -| ![](images/label-a.png) | [Toolbar](#toolbar): Contains options and tools for the Android Logcat window. | -| ![](images/label-b.png) | [Message log](#message-log): Lists the messages that Unity receives from Android Logcat. | +| ![Label A](images/label-a.png) | [Toolbar](#toolbar): Contains options and tools for the Android Logcat window. | +| ![Label B](images/label-b.png) | [Message log](#message-log): Lists the messages that Unity receives from Android Logcat. | ## Toolbar The toolbar contains options that customize the message log section and also additional tools that relate to Android Logcat and the connected Android device. -![](images/android-logcat-window-toolbar.png) +![The Android Logcat window toolbar](images/android-logcat-window-toolbar.png) > The Android Logcat window toolbar. | **Toolbar option** | **Description** | @@ -33,7 +33,7 @@ The toolbar contains options that customize the message log section and also add The message log section displays the messages that Unity receives from Android Logcat. It displays information for each message in predefined columns. -![](images/android-logcat-window-message-log.png) +![Message log column names on Android Logcat window](images/android-logcat-window-message-log.png) > Message log column names. | **Column name** | **Description** | @@ -60,7 +60,8 @@ The message log contains functionality that helps you to navigate through and sh You can access the **Process Manager** from the message log section when you right click on the selected message. The Process Manager helps you to manually invoke events related to a specific process, such as force an application to terminate or send memory trim events. -![](images/android-logcat-process-manager.png) +![Process Manager on Android Logcat window](images/android-logcat-process-manager.png) +> Process Manager. #### Terminate an application diff --git a/com.unity.mobile.android-logcat/Documentation~/connect-to-a-device.md b/com.unity.mobile.android-logcat/Documentation~/connect-to-a-device.md index 893ed22..0853d2b 100644 --- a/com.unity.mobile.android-logcat/Documentation~/connect-to-a-device.md +++ b/com.unity.mobile.android-logcat/Documentation~/connect-to-a-device.md @@ -20,14 +20,14 @@ To connect an Android device to the Android Logcat window: 4. Select **Other connection options**. 5. In window that opens, enter the device's IP address and select **Connect**. -![](images/AndroidLogcatIPWindow.png) +![The available devices window displaying connected devices](images/AndroidLogcatIPWindow.png) > The available devices window. ## Select a device You can only connect to one device at a time. To select which device to connect to, use the device list in the Android Logcat window. This list contains the device IDs of connnected devices. -![](images/connect_via_wifi.png) +![The device list drop-down displaying connected devices](images/connect_via_wifi.png) > The device list drop-down. > [!TIP] diff --git a/com.unity.mobile.android-logcat/Documentation~/inputs-window.md b/com.unity.mobile.android-logcat/Documentation~/inputs-window.md index d3961a0..fd81378 100644 --- a/com.unity.mobile.android-logcat/Documentation~/inputs-window.md +++ b/com.unity.mobile.android-logcat/Documentation~/inputs-window.md @@ -6,7 +6,7 @@ To open the Inputs window in the Unity Editor: 1. Open the [Android Logcat window](android-logcat-window.md). 2. In the [Toolbar](android-logcat-window-reference.md#toolbar), select **Tools** > **Window** > **Inputs**. -![](images/inputswindow.png) +![The inputs window](images/inputswindow.png) The inputs window is divided into five sections: * Keyboard keys @@ -22,7 +22,7 @@ The inputs window is divided into five sections: ## Keyboard keys -![](images/InputsWindow_Keyboard.png) +![The inputs window keyboard](images/InputsWindow_Keyboard.png) Includes letter, number, punctuation, symbol, function, and control keys. @@ -32,19 +32,19 @@ You can select **Shift** modifier to send keys as if while holding shift. ## Cursor keys -![](images/InputsWindow_Cursor.png) +![Cursor keys](images/InputsWindow_Cursor.png) Includes navigation keys. ## Numpad keys -![](images/InputsWindow_Numpad.png) +![Numpad keys](images/InputsWindow_Numpad.png) Includes numerical keys. ## Miscellaneous keys -![](images/InputsWindow_Misc.png) +![Miscellaneous keys](images/InputsWindow_Misc.png) Includes various helper keys for Android: * Volume keys @@ -59,18 +59,18 @@ Includes various helper keys for Android: * Back/Home/Menu ## TV keys -![](images/InputsWindow_TV.png) +![TV keys](images/InputsWindow_TV.png) Incluse basic TV keys. ## Media -![](images/InputsWindow_Media.png) +![Media keys](images/InputsWindow_Media.png) Incluse basic Media keys. ## Send text - ![](images/InputsWindow_SendText.png) + ![Send block of text](images/InputsWindow_SendText.png) Provides functionality for send block of text to Android device. \ No newline at end of file diff --git a/com.unity.mobile.android-logcat/Documentation~/memory-window-reference.md b/com.unity.mobile.android-logcat/Documentation~/memory-window-reference.md index 166cf24..24f3e06 100644 --- a/com.unity.mobile.android-logcat/Documentation~/memory-window-reference.md +++ b/com.unity.mobile.android-logcat/Documentation~/memory-window-reference.md @@ -9,19 +9,19 @@ To open the Memory window in the Unity Editor: If you select **Auto Capture**, Unity periodically captures memory snapshots for the selected application. If you deselect **Auto Capture**, the memory window provides a **Capture** button which you can use to manually capture a memory snapshot. This is useful if the automatic memory requests affect the application's performance. -![](images/MemoryWindow.png) +![The memory window](images/MemoryWindow.png) > The memory window. | **Label** | **Description** | | ----------------------- | ------------------------------------------------------------ | -| ![](images/label-a.png) | [Memory details panel](#memory-details-panel): Displays the amount of allocated memory for each memory type. | -| ![](images/label-b.png) | [Memory chart](#memory-chart): Contains a chart of the memory allocated for the connected application over time. | +| ![Label A](images/label-a.png) | [Memory details panel](#memory-details-panel): Displays the amount of allocated memory for each memory type. | +| ![Label B](images/label-b.png) | [Memory chart](#memory-chart): Contains a chart of the memory allocated for the connected application over time. | ## Memory details panel The memory details panel displays the amount of memory for each memory type. It can display different memory groups and. -![](images/memory-window-details-panel.png) +![The memory details panel](images/memory-window-details-panel.png) > The memory details panel. | **Property** | **Description** | @@ -60,14 +60,14 @@ To make memory requests, the Memory window uses `adb shell dumpsys meminfo packa The following screenshot shows the memory dump that `dumpsys` produces: -![](images/MemoryDump.png) +![A raw dumpsys memory dump](images/MemoryDump.png) > A raw `dumpsys` memory dump. ## Memory chart The memory chart displays the memory allocated for the connected application over time. - ![](images/MemoryWindowChart.png) + ![The memory chart](images/MemoryWindowChart.png) > The memory chart. To view a snapshot in the [memory details panel](#memory-details-panel), click on the chart at the part you want to view. diff --git a/com.unity.mobile.android-logcat/Documentation~/screen-capture-window-reference.md b/com.unity.mobile.android-logcat/Documentation~/screen-capture-window-reference.md index 701390d..a5bcd51 100644 --- a/com.unity.mobile.android-logcat/Documentation~/screen-capture-window-reference.md +++ b/com.unity.mobile.android-logcat/Documentation~/screen-capture-window-reference.md @@ -12,15 +12,15 @@ To open the Device Screen Capture window: | **Label** | **Description** | | ----------------------- | ------------------------------------------------------------ | -| ![](images/label-a.png) | [Toolbar](#toolbar): Contains options for the Device Screen Capture window. | -| ![](images/label-b.png) | [Recorder settings](#recorder-settings): Contains settings for video recording. | -| ![](images/label-c.png) | [Capture preview](#capture-preview): A preview of the screenshot or video captured from the device. | +| ![Label A](images/label-a.png) | [Toolbar](#toolbar): Contains options for the Device Screen Capture window. | +| ![Label B](images/label-b.png) | [Recorder settings](#recorder-settings): Contains settings for video recording. | +| ![Label C](images/label-c.png) | [Capture preview](#capture-preview): A preview of the screenshot or video captured from the device. | ## Toolbar The toolbar contains options to control the Screen Capture tool. -![](images/device-screen-capture-window-toolbar.png) +![The Device Screen Capture window toolbar](images/device-screen-capture-window-toolbar.png) > The Device Screen Capture window toolbar. | **Toolbar option** | **Description** | diff --git a/com.unity.mobile.android-logcat/Documentation~/stacktrace-utility-window-reference.md b/com.unity.mobile.android-logcat/Documentation~/stacktrace-utility-window-reference.md index eb186db..010eac6 100644 --- a/com.unity.mobile.android-logcat/Documentation~/stacktrace-utility-window-reference.md +++ b/com.unity.mobile.android-logcat/Documentation~/stacktrace-utility-window-reference.md @@ -7,13 +7,13 @@ To open the Stacktrace Utility window: 1. Open the [Android Logcat window](android-logcat-window.md). 2. From the [toolbar](android-logcat-window-reference.md#toolbar), select **Tools** > **Stacktrace Utility**. -![](images/stacktrace-utility-window.png) +![The Stacktrace Utility window](images/stacktrace-utility-window.png) > The Stacktrace Utility window. | **Label** | **Description** | | ----------------------- | ------------------------------------------------------------ | -| ![](images/label-a.png) | [Stacktrace display](#stacktrace-display): Contains a text area to enter a custom stacktrace, and a text area to display the resolved stacktrace. | -| ![](images/label-b.png) | [Stacktrace Utility controls](#stacktrace-utility-controls): Contains controls for the Stacktrace Utility window. | +| ![Label A](images/label-a.png) | [Stacktrace display](#stacktrace-display): Contains a text area to enter a custom stacktrace, and a text area to display the resolved stacktrace. | +| ![Label B](images/label-b.png) | [Stacktrace Utility controls](#stacktrace-utility-controls): Contains controls for the Stacktrace Utility window. | ## Stacktrace display