From c68c1132cedecf67030f0c7dac87d347e1930ab7 Mon Sep 17 00:00:00 2001
From: liujialiang <liujialiang10@huawei.com>
Date: Sun, 15 Jan 2023 16:43:39 +0800
Subject: [PATCH] Add description to flat_obj.h and switch fileformat to dos
 REASON There was not any description in flat_obj.h and the file format was
 dos.

SOLUTION
Add some necessary description of this head file and switch its file format.

Signed-off-by: liujialiang <liujialiang10@huawei.com>
---
 base/include/flat_obj.h | 94 ++++++++++++++++++++++-------------------
 1 file changed, 51 insertions(+), 43 deletions(-)

diff --git a/base/include/flat_obj.h b/base/include/flat_obj.h
index 0c7dd7c..be109d5 100644
--- a/base/include/flat_obj.h
+++ b/base/include/flat_obj.h
@@ -1,43 +1,51 @@
-/*
- * Copyright (c) 2021 Huawei Device Co., Ltd.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef UTILS_BASE_FLAT_OBJ_H
-#define UTILS_BASE_FLAT_OBJ_H
-
-#include <sys/types.h>
-#include <linux/types.h>
-
-#ifdef BINDER_IPC_32BIT
-    typedef __u32 binder_size_t;
-    typedef __u32 binder_uintptr_t;
-#else
-    typedef __u64 binder_size_t;
-    typedef __u64 binder_uintptr_t;
-#endif
-
-struct parcel_binder_object_header {
-    __u32 type;
-};
-struct parcel_flat_binder_object {
-    struct parcel_binder_object_header hdr;
-    __u32 flags;
-    union {
-        binder_uintptr_t binder;
-        __u32 handle;
-    };
-    binder_uintptr_t cookie;
-};
-
-#endif
+/*
+ * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file flat_obj.h
+ *
+ * @brief Define types and structures for reading and writing object in parcel.
+ *
+ * Types are platform-sensitive. Structures is only used for checking the
+ * validity of data in parcel, not for saving and using of data.
+ */
+#ifndef UTILS_BASE_FLAT_OBJ_H
+#define UTILS_BASE_FLAT_OBJ_H
+
+#include <sys/types.h>
+#include <linux/types.h>
+
+#ifdef BINDER_IPC_32BIT
+    typedef __u32 binder_size_t;
+    typedef __u32 binder_uintptr_t;
+#else
+    typedef __u64 binder_size_t;
+    typedef __u64 binder_uintptr_t;
+#endif
+
+struct parcel_binder_object_header {
+    __u32 type;
+};
+struct parcel_flat_binder_object {
+    struct parcel_binder_object_header hdr;
+    __u32 flags;
+    union {
+        binder_uintptr_t binder;
+        __u32 handle;
+    };
+    binder_uintptr_t cookie;
+};
+
+#endif
-- 
Gitee