Skip to content

Commit 87fab19

Browse files
authored
Cleanup some comments (#226)
* Cleanup comments * Apply suggested changes * Clarify which window returns
1 parent a20434c commit 87fab19

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

shell/platform/tizen/channels/window_channel.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
namespace flutter {
1616

17+
// Channel to get/set application's window size and device's screen size.
1718
class WindowChannel {
1819
public:
1920
explicit WindowChannel(BinaryMessenger* messenger,

shell/platform/tizen/external_texture.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ class ExternalTexture : public std::enable_shared_from_this<ExternalTexture> {
4040
}
4141
virtual ~ExternalTexture() = default;
4242

43-
/**
44-
* Returns the unique id for the ExternalTextureGL instance.
45-
*/
43+
// Returns the unique id for the ExternalTextureGL instance.
4644
int64_t TextureId() { return (int64_t)texture_id_; }
4745

4846
virtual bool PopulateTexture(size_t width,

shell/platform/tizen/external_texture_surface_gl.h

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,13 @@ class ExternalTextureSurfaceGL : public ExternalTexture {
2222

2323
virtual ~ExternalTextureSurfaceGL();
2424

25-
/**
26-
* Accepts texture buffer copy request from the Flutter engine.
27-
* When the user side marks the texture_id as available, the Flutter engine
28-
* will callback to this method and ask for populate the |opengl_texture|
29-
* object, such as the texture type and the format of the pixel buffer and the
30-
* texture object.
31-
* Returns true on success, false on failure.
32-
*/
25+
// Accepts texture buffer copy request from the Flutter engine.
26+
// When the user side marks the texture_id as available, the Flutter engine
27+
// will callback to this method and ask to populate the |opengl_texture|
28+
// object, such as the texture type and the format of the pixel buffer and the
29+
// texture object.
30+
//
31+
// Returns true on success, false on failure.
3332
bool PopulateTexture(size_t width,
3433
size_t height,
3534
FlutterOpenGLTexture* opengl_texture) override;

shell/platform/tizen/flutter_tizen_texture_registrar.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,23 @@ class FlutterTizenTextureRegistrar {
2222
explicit FlutterTizenTextureRegistrar(FlutterTizenEngine* engine);
2323

2424
// Registers a texture described by the given |texture_info| object.
25-
// Returns the non-zero, positive texture id or -1 on error.
25+
//
26+
// Returns a non-zero positive texture id, or -1 on error.
2627
int64_t RegisterTexture(const FlutterDesktopTextureInfo* texture_info);
2728

2829
// Attempts to unregister the texture identified by |texture_id|.
30+
//
2931
// Returns true if the texture was successfully unregistered.
3032
bool UnregisterTexture(int64_t texture_id);
3133

3234
// Notifies the engine about a new frame being available.
35+
//
3336
// Returns true on success.
3437
bool MarkTextureFrameAvailable(int64_t texture_id);
3538

3639
// Attempts to populate the given |texture| by copying the
3740
// contents of the texture identified by |texture_id|.
41+
//
3842
// Returns true on success.
3943
bool PopulateTexture(int64_t texture_id,
4044
size_t width,

shell/platform/tizen/public/flutter_tizen.h

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,10 @@ FlutterDesktopGetPluginRegistrar(FlutterDesktopEngineRef engine,
9191
FLUTTER_EXPORT FlutterDesktopMessengerRef
9292
FlutterDesktopEngineGetMessenger(FlutterDesktopEngineRef engine);
9393

94-
/**
95-
* Return backing window for manipulation in host application.
96-
*
97-
* If run engine on a wearable device, need cast void* to Evas_Objct*,
98-
* otherwise cast void* to Ecore_Wl2_Window*.
99-
*/
94+
// Returns the window associated with this registrar's engine instance.
95+
//
96+
// If the app runs on a wearable device, cast void* to Evas_Object*,
97+
// otherwise cast it to Ecore_Wl2_Window*.
10098
FLUTTER_EXPORT void* FlutterDesktopGetWindow(
10199
FlutterDesktopPluginRegistrarRef registrar);
102100

0 commit comments

Comments
 (0)